# Component: Cancel Survey

**Purpose:** To record the reasons for a cancellation and route the customer to the correct experience (See [How to create a personalised cancel/save experience with Discounts or Switch Offers](https://docs.limio.com/product/self-service/what-are-the-standard-functionality-of-limio-self-service-manage-my-account/how-to-create-a-personalised-cancelsave-experience) for more details. The cancellation reason will be stored in Limio and can be passed to other systems ([Integration of Cancel Survey reasons into other platforms.](#h01gbqn9xdgmt9nvj1rhf08qfhm))

{% embed url="<https://69c2cf3a42a094f3cd354b8d-ojozztnsdo.chromatic.com/?path=/story/shop-components-cancellation-cancel-survey--default&full=1&shortcuts=false&singleStory=true&embed=true>" %}

## Props

| **id**                          | **label**            | **type** | **default**                                                                          | **Purpose**                                                                                          |
| ------------------------------- | -------------------- | -------- | ------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------- |
| title                           | Title                | string   | Before you go                                                                        | Header text visible to the customer                                                                  |
| subtitle                        | Subtitle             | string   | Please tell us why you want to cancel your subscription                              | Subtitle text visible to the customer                                                                |
| arrange                         | Arrange              | picklist | horizontal                                                                           | Formatting option                                                                                    |
| squareTheme                     | Square Theme?        | boolean  | FALSE                                                                                | Formatting option                                                                                    |
| reasons                         | Reasons              | list     | See below                                                                            | List of cancel reasons - see table below                                                             |
| goBackUrl                       | Go Back URL          | string   | /mma                                                                                 | Link to go back                                                                                      |
| redirectUrl                     | Redirect URL         | string   | /mma                                                                                 | Link for redirect (which can point to different Campaigns/Journeys/Pages based on the cancel reason) |
| feedbackPlaceholder             | Feedback Placeholder | string   | Tell us what you would have made your experience better                              | Feedback text visible to the customer                                                                |
| confirmationTitle               | Confirmation Title   | string   | Are you sure you want to cancel?                                                     | Cancel modal text visible to the customer                                                            |
| confirmationBody                | Confirmation Body    | string   | Your subscription will lapse at the end of your term and you will lose all benefits. |                                                                                                      |
| confirmationOk                  | Confirmation Ok      | string   | OK                                                                                   |                                                                                                      |
| confirmationCancel              | Confirmation Cancel  | string   | Cancel                                                                               |                                                                                                      |
| iconPrimary\_\_limio\_color     | Icon Primary Color   | color    | rgba(0,0,0,.3)                                                                       | Color scheme for the reason icons                                                                    |
| iconSecondary\_\_limio\_color   | Icon Secondary Color | color    | rgba(0,0,0,.1)                                                                       |                                                                                                      |
| backgroundColor\_\_limio\_color | Background Color     | color    | #fff                                                                                 |                                                                                                      |
| componentId                     | Component Id         | string   | cancel-survey-limio                                                                  |                                                                                                      |

**Reasons:**

| **id**      | **label**                              | **url**             | **buttonImage** | **straightToUrl\_\_limio\_boolean** | **showCta\_\_limio\_boolean** | **ctaText**                                                  | **ctaImage** |
| ----------- | -------------------------------------- | ------------------- | --------------- | ----------------------------------- | ----------------------------- | ------------------------------------------------------------ | ------------ |
| expensive   | This subscription is too expensive     | /save               |                 | FALSE                               | TRUE                          | We can offer you a discount.                                 |              |
| quantity    | I have too much                        | <support@limio.com> |                 | FALSE                               | TRUE                          | We understand. Please contact us to talk about your options. |              |
| dislike     | I did not like the membership benefits |                     |                 | FALSE                               | FALSE                         |                                                              |              |
| alternative | I found an alternative                 |                     |                 | FALSE                               | FALSE                         |                                                              |              |
| other       | Other reasons                          |                     |                 |                                     | FALSE                         |                                                              |              |
|             |                                        |                     |                 |                                     |                               |                                                              |              |

## Integration of Cancel Survey reasons into other platforms

* **Zuora/Salesforce (via Zuora Z360):** To pass the cancellation reason to Zuora, create a Custom Field on the Subscription Object called Cancellation Reason (the API name must be CancellationReason\_\_c). Create then **Picklist Values that maps exactly to the Reason Id** defined on the Cancel Survey component.

<figure><img src="https://limio.zendesk.com/hc/article_attachments/6539098997789/Screenshot_2022-08-30_at_16.08.46.png" alt=""><figcaption></figcaption></figure>

<figure><img src="https://limio.zendesk.com/hc/article_attachments/6538973750301/Screenshot_2022-08-30_at_16.03.55.png" alt=""><figcaption></figcaption></figure>

\- **Other systems (or directly into Salesforce):** You can use the Subscription Offer Change, Subscription Offer Change, Subscription Offer Addition and Subscription Cancellation webhooks and feed into the relevant systems. See [How to implement webhooks to track events for more details](https://docs.limio.com/developers/webhooks/using-webhooks).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.limio.com/components/component-library/standard-components/component-cancel-survey.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.