Skip to main content
POST
Apply the retention offer the customer took instead of cancelling

Authorizations

x-cms-token
string
header
required

CMS session JWT from /api/v1/cms/session/login. Customer account operations require an email-verified session; signed offer links accept an anonymous store session.

Body

application/json
target
object
required
reasonId
string
required
Minimum string length: 1
offerId
string
required
Minimum string length: 1
optionId
string
Minimum string length: 1
productId
string
Minimum string length: 1
variantId
string
Minimum string length: 1
days
integer
Required range: 1 <= x <= 365

Response

Successful response

subscription
object | null
required
membership
object | null
required