Cancel a subscription checkout

PATCH/subscription-checkouts/{id}/cancel

Cancel a pending subscription checkout intent before the customer signs. This cancels the intent only — to cancel an active on-chain subscription, use the subscriptions endpoint. Cancelling does not abort an in-flight subscribeAndCharge transaction; if it later confirms, the intent flips back to completed.

Headers

Header	Description	Required
Authorization	Bearer token with your secret API key	yes

Path Parameters

Name	Type	Required	Description
id	string	yes

Request Body

Field	Type	Required	Description
cancellation_reason	enum: merchant_initiated \| subscriber_declined	—

Example Request

Request

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

Responses

Status	Description
200	The cancelled subscription checkout.
400	Validation error
401	Missing or invalid authentication
403	API key lacks the required scope
404	Resource not found

Response body

Field	Type	Required	Description
object	enum: subscription_checkout	yes
id	string	yes
status	enum: pending \| completed \| expired \| cancelled	yes
onchain_id	string	yes
business_name	string	yes
background_color	string \| null	yes
primary_color	string \| null	yes
subscriber	string \| null	yes
external_customer_id	string \| null	yes
subscription_options	object[]	yes	Every chain/token combination the subscriber may pick at subscribe time. Always an array -- do not assume a single entry.
price	string	yes	The recurring per-cycle amount, in price_currency's minor units. price, cap, and budget share one unit system; fiat figures convert to exact-out token amounts at subscribe/charge time via a quote, never pre-converted here.
price_currency	string \| null	yes	ISO-4217 pricing currency. Always set on checkouts created after fiat-only creation shipped; null only on legacy rows.
period_duration	number	yes
cap	string \| null	yes	Per-charge ceiling, same unit system as price.
budget	string	yes	Per-window spend ceiling, same unit system as price.
initial_charge	boolean	yes
checkout_url	string	yes
success_url	string \| null	yes
cancel_url	string \| null	yes
return_url	string \| null	yes
metadata	object \| null	yes
expires_at	string	yes
created_at	string	yes
updated_at	string	yes
completed_at	string \| null	yes
cancelled_at	string \| null	yes
expired_at	string \| null	yes
cancellation_reason	string \| null	yes

subscription_options

Field	Type	Required
chain	string	yes
token	string	yes
subscription_manager_address	string	yes
relayer_address	string	yes

Example Response

{
  "object": "subscription_checkout",
  "id": "schk_1234567890abcdef",
  "status": "completed",
  "onchain_id": "0x9f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a",
  "business_name": "Acme Inc",
  "background_color": "#0f172a",
  "primary_color": "#7c3aed",
  "subscriber": "0x742d35Cc6634C0532925a3b844Bc9e7595f8fE21",
  "external_customer_id": "cus_42",
  "subscription_options": [
    {
      "chain": "eip155:1",
      "token": "USDC",
      "subscription_manager_address": "0xa1b2c3d4e5f6789012345678901234567890abcd",
      "relayer_address": "0x9a8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d3e2f1a0b"
    },
    {
      "chain": "eip155:137",
      "token": "USDC",
      "subscription_manager_address": "0xb2c3d4e5f67890123456789012345678901234cd",
      "relayer_address": "0x9a8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d3e2f1a0b"
    }
  ],
  "price": "250000",
  "price_currency": "ARS",
  "period_duration": 2592000,
  "cap": "1000000",
  "budget": "2500000",
  "initial_charge": true,
  "checkout_url": "https://checkout.exodus-int.com/subscribe/schk_1234567890abcdef",
  "success_url": "https://merchant.com/subscribed",
  "cancel_url": "https://merchant.com/cancelled",
  "return_url": "https://merchant.com/plans/pro",
  "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:02:18Z",
  "completed_at": "2026-05-19T12:02:18Z",
  "cancelled_at": null,
  "expired_at": null,
  "cancellation_reason": null
}

Error Response

Error (e.g. 400)

{
  "error": {
    "type": "validation_error",
    "message": "amount must be a positive number",
    "param": "amount"
  }
}

Intent vs. Subscription

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.

Retrieve a subscription checkout Overview