curl --request POST \
--url https://development.knotapi.com/subscriptions/cancel \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"external_user_id": "abc",
"merchant_id": 18
}
'{
"message": "Success"
}SubscriptionManager
Cancel Subscription By Account
Cancel a subscription or bill associated with a linked merchant account
POST
/
subscriptions
/
cancel
curl --request POST \
--url https://development.knotapi.com/subscriptions/cancel \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"external_user_id": "abc",
"merchant_id": 18
}
'{
"message": "Success"
}Authorizations
Body
application/json
The input parameters required for cancelling a subscription or bill on a merchant account.
The cancellation attempt fails and triggers the CANCELLATION_FAILED webhook. Requires exactly one cancellable subscription on the merchant account; otherwise the matching CANCELLABLE_SUBSCRIPTION_NOT_FOUND or MULTIPLE_CANCELLABLE_SUBSCRIPTIONS_FOUND error is returned instead.
Allowed value:
"failed"Example:
"failed"
Was this page helpful?