LOloopwork

Apply cancellation offer

This endpoint allows you to apply the cancellation offer to specific subscriber.

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

Request

  • Base URL
    https://api.loopsubscriptions.com/storefront
  • URL
    https://api.loopsubscriptions.com/storefront/2023-10/subscription/{subscriptionId}/cancellationOffer
  • Auth
    API key in header Authorization

Path parameters

subscriptionIdinteger required

The unique identifier for a subscription in Loop.

Request body

cancellationFlowIdinteger

The unique identifier of the cancellation flow (reason selected by the subscriber). This value is used to log analytics for the cancellation flow.

cancellationOfferIdstring

The unique identifier of the cancellation offer to be applied. This value can be retrieved from the List cancellation offer(s) API.

Response

200

successboolean

Indicates whether the request was successfully processed.

messagestring

Human-readable message describing the result of the operation.

datastring

Additional response data returned by the system.

codestring

Status code indicating the result of the operation.

pageInfostring

Additional metadata related to the response.

Example response

{
  "success": true,
  "message": "Cancellation offer applied successfully",
  "code": "SUCCESS"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.