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"
}Cancel Subscription By Account
Cancel a subscription or bill associated with a linked merchant account
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
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password. Use your client_id as the username and your secret as the password value.
Body
The input parameters required for cancelling a subscription or bill on a merchant account.
Your unique identifier for the user.
"abc"
The unique ID of the merchant whose linked account the subscription is cancelled on.
18
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.
"failed""failed"
Response
Cancellation request accepted.
"Success"
Was this page helpful?