Skip to main content
POST
Execute a configured cancellation retention offer and record the retention activity

Body

application/json
billingAttemptId
integer<int64>
billingInterval
enum<string>
Available options:
DAY,
WEEK,
MONTH,
YEAR,
$UNKNOWN
billingIntervalCount
integer<int32>
cancellationReason
string
compatibleSellingPlanId
string
contractId
integer<int64>
eventSource
enum<string>
Available options:
PAUSE,
CANCELLATION
feedback
string
flowId
integer<int64>
flowReasonId
string
frequencyKey
string
nextBillingDate
string<date-time>
offerTier
string
pauseDurationCycle
integer<int32>
reasonId
string
replaceVariantsInfo
object

Product replacement configuration for subscription contracts. Allows replacing existing subscription products with new ones, managing quantities, and handling one-time purchases.

rescheduleFutureOrder
boolean
retentionAction
integer<int32>
sellingPlanId
integer<int64>
shippingAddress
object
skipCycle
integer<int32>

Response

200 - */*

OK

cancellationReason
string
contractId
integer<int64>
eventSource
enum<string>
Available options:
PAUSE,
CANCELLATION
retentionAction
integer<int32>
retentionActionLabel
string
retentionActivity
object