For the complete documentation index, see llms.txt. This page is also available as Markdown.

Subscription churn prevention campaigns

The object below is returned directly or within a successful response from the following API request:

Response parameters

Parameter
Type / Description

AvailableCancellationReasons

Object with dynamic properties (as reasons number can change in time)

AvailableCancellationReasons.REASON_CODE_1

Required (string)

AvailableCancellationReasons.REASON_CODE_3

Required (string)

AvailableCancellationReasons.REASON_CODE_5

Required (string)

AvailableCancellationReasons.REASON_CODE_6

Required (string)

AvailableCancellationReasons.REASON_CODE_7

Required (string)

AvailableCancellationReasons.REASON_CODE_9

Required (string)

Campaigns

Array of objects

Campaigns.Code

String

Unique, system-generated campaign identifier.

Campaigns.Name

String

Name of the campaign.

Campaigns.DefaultMessage

String

Default message of the campaign displayed to shoppers.

Campaigns.CancellationReasonRequired

Boolean

Indicates if collecting feedback from customers is required.

Campaigns.OfferPause

Boolean

Indicates if shoppers are allowed to pause the subscription.

Campaigns.OfferDiscount

Object containing

Campaigns.OfferDiscount.Message

String

Discount message.

Campaigns.OfferDiscount.Discount

String

Discount value as a decimal number.

Campaigns.OfferDiscount.BillingCycles

String

Number of billing cycles.

Last updated

Was this helpful?