For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
  • GraphQL
    • Overview
      • Overview
          • MUTaddUserToAccount
          • MUTremoveUserFromAccount
          • MUTcreateCheckout
          • MUTcancelSubscription
          • MUTcreateUserWithPassword
          • MUTcreateUser
          • MUTaddUserToStore
          • MUTremoveUserFromStore
          • MUTcreateEventSource
          • MUTdeleteEventSource
  • MCP
    • Overview
Dev Portal
LogoLogo
GraphQLAccountMutations

cancelSubscription

Example Query
1mutation ExampleMutation($input: CancelSubscriptionInput) {
2  cancelSubscription(input: $input) {
3    subscriptionId
4    cancelledAt
5  }
6}
Variables
1{
2  "input": {
3    "id": "example"
4  }
5}
Example response
1{
2  "data": {
3    "cancelSubscription": {
4      "subscriptionId": "example",
5      "cancelledAt": "DateTime"
6    }
7  }
8}
Cancels a Subscription for a Merchant.
Was this page helpful?
Previous

createCheckout

Next

createUserWithPassword

Built with

Arguments

inputCancelSubscriptionInputRequired

Returns

an optional CancelSubscriptionResult
subscriptionIdString
The ID of the Subscription.
cancelledAtDateTime
The date the subscription will be cancelled.