Cancel Subscription Checkout

PATCH/subscription-checkouts/:id/cancel

Description

Cancel a pending subscription checkout intent before the customer signs. Use this when the customer abandons the checkout, the order is voided merchant-side, or the intent should no longer be honored.

This endpoint cancels the intent. To cancel an active on-chain subscription, use POST /subscriptions/:id/cancel instead.

⚠️

Cancelling a pending intent does NOT abort an in-flight on-chain subscribeAndCharge transaction. If the customer’s transaction is in the mempool when you cancel and confirms after, the indexer flips the intent back to completed and you receive a subscription_checkout.completed webhook. Merchants must handle this case. The latest webhook is authoritative.

Headers

Header	Description	Required
Authorization	Bearer token with your API key	yes
Content-Type	application/json	no

Path Parameters

Name	Type	Description	Required
id	string	The subscription checkout ID (e.g. `schk_1234567890abcdef`).	yes

Body Parameters

Name	Type	Description	Required
cancellation_reason	string	Optional reason for cancellation: `merchant_initiated` or `subscriber_declined`.	no

Example Request

cancel-subscription-checkout.js

const response = await fetch(
  'https://checkout-api.exodus-int.com/subscription-checkouts/schk_1234567890abcdef/cancel',
  {
    method: 'PATCH',
    headers: {
      Authorization: 'Bearer sk_live_xxxxxxxxxxxxxxxx',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      cancellation_reason: 'merchant_initiated',
    }),
  },
);
 
const intent = await response.json();
console.log(intent.status); // "cancelled"

Response

SUCCESSFUL RESPONSE

{
  "object": "subscription_checkout",
  "id": "schk_1234567890abcdef",
  "status": "cancelled",
  "onchain_id": "0x9f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a",
  "business_name": "Acme Inc",
  "subscriber": null,
  "external_customer_id": "cus_42",
  "subscription_options": [
    { "chain": "eip155:1", "token": "USDC", "subscription_manager_address": "0xa1b2c3d4e5f6789012345678901234567890abcd", "relayer_address": "0xd4e5f6a7b8c90123456789012345678901234ef1" },
    { "chain": "eip155:137", "token": "USDC", "subscription_manager_address": "0xb2c3d4e5f67890123456789012345678901234cd", "relayer_address": "0xe5f6a7b8c9d012345678901234567890123456f2" }
  ],
  "price": "9990000",
  "price_currency": null,
  "period_duration": 2592000,
  "cap": "120000000",
  "budget": "300000000",
  "checkout_url": "https://checkout.exodus-int.com/subscribe/schk_1234567890abcdef",
  "success_url": "https://merchant.com/subscribed",
  "cancel_url": "https://merchant.com/cancelled",
  "metadata": { "external_plan_ref": "pro_monthly" },
  "expires_at": "2026-05-19T12:05:00Z",
  "created_at": "2026-05-19T12:00:00Z",
  "updated_at": "2026-05-19T12:03:11Z",
  "completed_at": null,
  "cancelled_at": "2026-05-19T12:03:11Z",
  "expired_at": null,
  "cancellation_reason": "merchant_initiated"
}

Cancel by current state

Current `status`	Response	Notes
`pending`	`200` — `status: cancelled`	Fires `subscription_checkout.cancelled` webhook.
`cancelled`	`200` — existing record	Idempotent no-op. Webhook does not re-fire.
`completed`	`400 invalid_request`	Cancel the materialized subscription via `POST /subscriptions/:id/cancel`.
`expired`	`400 invalid_request`	Intent has expired; nothing to cancel.

Errors

Status	Code	Description
400	`invalid_request`	The intent can’t be cancelled because its status is `completed` or `expired`.
404	`not_found`	Intent ID does not exist.
403	`forbidden`	Intent belongs to another merchant.

Webhook Fired

subscription_checkout.cancelled — fires once on the pending → cancelled transition. Re-cancels do not re-fire.