v1

latestOpenAPI 3.1.02026-07-241120379.1 KB

List cancellation offer

This endpoint allows you to fetch a single cancellation offer specific to a subscription.

get/2023-10/subscription/{subscriptionId}/cancellationOffer

Path parameters

subscriptionIdinteger required

The unique identifier for a subscription in Loop.

Query parameters

cancellationFlowIdinteger required

The unique identifier of the cancellation reason selected by the subscriber. This value can be retrieved from the List cancellation reasons API.

Response

200

successboolean

messagestring

codestring

pageInfostring

Example response

{
  "success": true,
  "message": "Cancellation offer fetched successfully",
  "data": {
    "id": "ba70d90886454e6985099b99673ac7de",
    "message": "<undefined>choice 1<br></undefined>",
    "keepSubscriptionCTAText": "Accept offer - choice 1",
    "cancelSubscriptionCTAText": "Cancel subscription",
    "title": "Cancel subscription",
    "offerDescription": "choice 1"
  },
  "code": "SUCCESS"
}