get-api-auth-subscription_meta

Subscription Meta

​

Returns subscription cancellation reasons, which 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, then the API won't return any subscription cancellation reasons in the Subscription Meta API response.

Contact your Punchh representative to update this configuration.

Headers
  • Accept
    Type: string
    required

    Advertises which content types the client is able to understand

  • Accept-Language
    Type: string

    Preferred language. Punchh supports multiple languages for the subscription plan name, description, and miscellaneous parameters in the API response as per the locale specified in the Accept-Language request header. Possible values: es for Spanish, fr for French, fr-ca for French-Canada, en-CY for English-Cyprus, ro for Romania, es-US for Spanish United States, etc. The locales for a business are configured in the Punchh platform under Administration > Business Profile > Address > Alternate Languages. Administrators have to configure Name, Description, and Miscellaneous fields in the relevant language(s) on the subscription plan in the Punchh platform under Wallet and Passes > Subscription Plans. If these fields are not configured in Punchh in the language specified in the Accept-Language request header, then the API response will include the subscription plan name, description, and miscellaneous parameters with empty values.

  • Content-Type
    Type: string
    required

    Set this header to application/json

  • x-pch-digest
    Type: string
    required

    Signature generated using the request path, body, and OAuth secret provided by the business

Body
application/json
  • client
    Type: string
    required

    OAuth client ID provided by the business

Responses
  • 200
    Type: object
    • 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 is to be collected at the time when guests cancel a subscription or not.

    • subscription_cancellation_reasons
      Type: array Subscription Cancellation Reasons[]

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

  • 422
    Type: object
    • error
      Type: object
get/api/auth/subscription_meta
{
  "enable_cancellation_feedback": true,
  "cancellation_feedback_placeholder": "string",
  "subscription_cancellation_reasons": [
    {
      "component_code": "string",
      "cancellation_reason_id": 1,
      "cancellation_reason": "string"
    }
  ]
}

OK