Subscription churn prevention campaigns
The object below is returned directly or within a successful response from the following API requests:
Retrieve eligible churn prevention campaigns
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 whether shoppers must provide a cancellation reason; used to decide if you allow shoppers to pause subscription.
Campaigns.OfferDiscount
Object
Campaigns.OfferDiscount.Message
String
Discount message.
Campaigns.OfferDiscount.Discount
String
Discount value (decimal number).
Campaigns.OfferDiscount.BillingCycles
String
Number of billing cycles.
Last updated
Was this helpful?