PATCH
/
2022-06-09
/
subscriptions
/
{subscriptionLocator}
/
cancel
Cancel Subscription
curl --request PATCH \
  --url https://staging.crossmint.com/api/2022-06-09/subscriptions/{subscriptionLocator}/cancel \
  --header 'X-API-KEY: <api-key>'
{}

Authorizations

​
X-API-KEY
string
header
required

Obtained in the Crossmint developer console

Path Parameters

​
subscriptionLocator
string
required

The unique identifier for the subscription, formatted as chain:contractAddress:tokenId. This locator references the specific token associated with the subscription.

Example:

"base:0x1234567890123456789012345678901234567890:1"

Response

Subscription successfully cancelled.

The response is of type object.