Skip to main content
POST
Call off a scheduled plan change

Authorizations

X-Suby-Api-Key
string
header
required

Secret API key. sk_live_… (production) or sk_sandbox_… (sandbox).

Headers

Idempotency-Key
string

Optional key (≤255 chars, e.g. a UUID v4) that makes this POST safe to retry: the first request executes and its response is cached for 24h; a retry with the SAME key replays that response instead of re-executing (no duplicate payment/subscription). A reused key with a different request → 422 IDEMPOTENCY_KEY_CONFLICT; a retry while the first is still in flight → 409. See the Idempotency guide.

Maximum string length: 255
Example:

"5f3b9c2e-1a4d-4f2b-9c31-7e2a1b6d8c04"

Path Parameters

id
string
required
Example:

"sub_abc123"

Body

application/json
scheduledChangeId
string

Optional guard — the change you read from GET /v3/subscriptions/{id}. When it does not name the queued change the request is refused (NO_SCHEDULED_PLAN_CHANGE) rather than applied to whatever is queued.

Example:

"ssc_abc123"

Response

The queued change was called off

success
boolean
required
Example:

true

data
object
required

Endpoint-specific payload.

message
string