Cancel Subscription (Turn off Auto Renewal)

This API can be used to cancel an active subscripition.

Headers

Content-Type
Type: string
required

application/json
Accept
Type: string
required

application/json
Authorization
Type: string

Bearer token for admin authorization, who is making a call on behalf of the customer

Body

application/json

cancellation_reason
Type: string
min length:
1
required

Reason provided by the admin at the time of cancellation
cancellation_type
Type: string
min length:
1enum
required

Type of cancellation -- either "hard_cancelled" or "soft_cancelled". If “soft_cancelled”, end users can enjoy the benefits until the “end_time” of the subscription. If “hard_cancelled”, subscription benefits are terminated immediately.
values
- hard_cancelled
- soft_cancelled
subscription_id
Type: integerFormat: int64
required

Punchh-generated unique ID of the subscription that needs to be cancelled

Responses

application/json
application/json
application/json
application/json

patch/api2/dashboard/subscriptions/cancel

curl https://SERVER_NAME_GOES_HERE.punchh.com/api2/dashboard/subscriptions/cancel \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'Authorization: ' \
  --data '{
  "subscription_id": "126",
  "cancellation_reason": "Do not like your service",
  "cancellation_type": "hard_cancelled"
}'

Show Schema

[
  "Subscription auto renewal cancelled."
]