v1

latestOpenAPI 3.1.02026-07-241120379.1 KB

Subscription benefit content

This endpoint allows you to fetch the subscription benefit content associated with a specific subscription id.

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

Path parameters

subscriptionIdinteger required

The unique identifier for a subscription in Loop.

Response

200

successboolean

Indicates whether the request was successfully processed.

messagestring

A human-readable message describing the result of the request.

codestring

Status code indicating the result of the operation.

pageInfostring

Additional metadata related to the response.

Example response

{
  "success": true,
  "message": "Benefit content fetched successfully",
  "data": {
    "id": 23,
    "title": "Cancellation surveys",
    "body": "<div><span class=\"fr-video fr-deletable fr-fvc fr-dvi fr-draggable\" contenteditable=\"false\"><video autoplay=\"true\" id=\"cancellationBenefitVideo\" width=\"360\" height=\"auto\" controls=\"\" class=\"fr-fvc fr-dvi fr-draggable\"><source src=\"https://cdn.shopify.com/videos/c/o/v/a30d2cbfdfc04fdeb0578b959db059a0.mp4\" type=\"video/mp4\"></video></span></div><br>",
    "keepSubscriptionCTA": "Keep subscription",
    "cancelSubscriptionCTA": "Cancel subscription"
  },
  "code": "SUCCESS"
}