Subscriptions (Object)

The object contains details related to subscription configurations, including subscription cancellation reasons for the business. The subscription cancellation reasons are configured in the Punchh platform under Wallet and Passes > Subscription Cancellation Reasons.

Note: If the option to enable meta cache update on request is not enabled in the Punchh platform, the API will not return any subscription cancellation reasons in the Program Meta API response. Contact your Punchh representative to update this Punchh platform configuration.

cancellation_feedback_placeholder
Type: string

This is the cancellation feedback placeholder, which can be used by app developers as the title/label/placeholder text while capturing subjective feedback from guests when they cancel a subscription.
enable_cancellation_feedback
Type: boolean

Whether feedback will be collected when guests cancel a subscription or not
payment_disclaimer_text
Type: string

Payment disclaimer text as configured in the Punchh platform
subscription_cancellation_reasons
Type: array of object

Different cancellation reasons that the business has configured and guests can select from within the mobile app when cancelling a subscription

Properties: 3
terms_and_conditions
Type: string

Terms and conditions text as configured in the Punchh platform

Examples

{
  "subscriptions": {
    "subscription_cancellation_reasons": [
      {
        "component_code": "Price",
        "cancellation_reason_id": 1,
        "cancellation_reason": "It is expensive"
      },
      {
        "component_code": "Cancel ",
        "cancellation_reason_id": 3,
        "cancellation_reason": "Reason"
      },
      {
        "component_code": "code",
        "cancellation_reason_id": 6,
        "cancellation_reason": "reason"
      }
    ],
    "enable_cancellation_feedback": true,
    "cancellation_feedback_placeholder": "Enter Additional Feedback If Any",
    "payment_disclaimer_text": "This is payment disclaimer text.",
    "terms_and_conditions": "These are terms and conditions."
  }
}

Rewards (Array Object)

Subscriptions Payment Credential (Object)