Subscription benefit action

This endpoint allows you to log whether a subscriber accepts or rejects the benefit content shown during the retention or cancellation flow. The logged action helps brands analyze subscriber behavior and measure the effectiveness of retention benefits.

Path parameters explained

subscriptionId - Id of the subscription for which you want to log the subscription benefit action. This value can be passed in the following format:

  • {id} - where id is the Loop internal id of the subscription contract. This is the default path param format.
  • loop-{id} where id is the Loop internal id of the subscription contract.
  • shopify-${id}- Where id is the shopifySubscriptionId of the subscription contract.

Body parameters explained

  • benefitContentId - The unique identifier of the benefit content shown to the subscriber. This value is returned by the Subscription benefit page content API and is used to link the subscriber’s action to the specific benefit displayed.
  • state - Represents the subscriber’s decision after viewing the benefit content.
    • ACCEPTED - Subscriber accepts the benefit and keeps the subscription.
    • REJECTED - Subscriber rejects the benefit and proceeds with cancellation.
Path Params
int32
required

The unique identifier for a subscription in Loop.

Body Params
int32
required

The unique identifier of the benefit content that was shown to the subscriber.

string
enum
required

Indicates whether the subscriber accepted or rejected the benefit offered during the retention flow. It only accepts 2 values: ACCEPTED or REJECTED

Allowed:
Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json