Get cancellation flow settings

Retrieves the cancellation management configuration including retention offers, cancellation reasons, and survey settings.

GET /memberships/cp/api/cancellation-managements/{id}

Get cancellation flow settings

cURL

curl --request GET \
  --url https://www.myshop.com/apps/memberships/cp/api/cancellation-managements/{id}

200

{
  "shop": "my-store.myshopify.com",
  "id": 101,
  "cancellationInstructionsText": "<string>",
  "cancellationReasonsJSON": "<string>",
  "cancellationRetentionMessage": "<string>",
  "pauseDurationCycle": 123,
  "dynamicallyPauseCycleOnCancellation": true,
  "discountRecurringCycleLimit": 123
}

Path Parameters

id · integer<int64> · required

Response

200 - */*

OK

shop · string · required

Shop domain identifier

Example:

"my-store.myshopify.com"

id · integer<int64>

Unique identifier of the cancellation management config

Example:

101

cancellationType · enum<string>

Type of cancellation flow to present to customers

Available options: CANCEL_IMMEDIATELY, CANCELLATION_INSTRUCTIONS, CUSTOMER_RETENTION_FLOW

cancellationInstructionsText · string

Custom instructions text shown during cancellation

cancellationReasonsJSON · string

JSON array of cancellation reason options presented in the survey

cancellationRetentionMessage · string

Retention message shown to discourage cancellation

pauseDurationCycle · integer<int32>

Number of billing cycles to pause when pause option is selected

dynamicallyPauseCycleOnCancellation · boolean

discountRecurringCycleLimit · integer<int32>

Number of billing cycles the retention discount applies to