v2.subscriptions

Cancel v2 subscriptions

Scoped to the authenticated store or the connected account in Cooud-Account. Sandbox lists no live subscriptions and returns 404 on retrieval/cancellation. Cancellation is immediate, without refund or period-end scheduling.

post/subscriptions/{id}/cancel

Request

  • Base URL: https://api.cooud.com/v2
  • URL: https://api.cooud.com/v2/subscriptions/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idstring required

Headers

Cooud-Compat-Datestring date required

Required per-request compat-date. Format: ISO calendar date YYYY-MM-DD. Merchants pinned to an older date have their request and response transformed by every gate whose appliesAfter is strictly greater than this date.

Cooud-Accountstring

Cooud Connect: connected account a PLATFORM key acts on behalf of, in the form cooud_acct_<26-char ULID> (the seller's store; list them with GET /accounts). Required on every store-scoped operation when the bearer is a platform key (cooud_account_required otherwise); rejected with cooud_account_not_allowed when the bearer is a store key or on platform operations such as GET /accounts. An account whose owner is not an active managed seller of the platform yields 403 account_not_connected and nothing is created. For an explicitly enabled central-receiving platform, cooud_subacct_<26-char ULID> selects an internal subaccount from GET /subaccounts. These IDs are not accepted by /accounts KYC routes. Existing cooud_acct IDs never alias central subaccount stores.

Request body

object required

Response

Successful cancel

idstring required
object'subscription' required
livemodetrue required
status'incomplete' | 'active' | 'unpaid' | 'canceled' required
customer_idstring required
customer_emailstring nullable required
product_namestring required
amountinteger required
currencystring required
intervalstring required
interval_countinteger required
current_period_startinteger required
current_period_endinteger required
cancel_at_period_endboolean required
canceled_atinteger nullable required
createdinteger required
accountstring
request_idstring

Changes

No recorded changes to this operation across all 1 revision of this API.