RevKeenDocs
StatusSupport
API Reference
📋 Billing & SubscriptionsSubscriptions

Cancel subscription

Cancel a subscription either immediately or at the end of the current billing period.

POST/subscriptions/{id}/cancel

Cancel a subscription either immediately or at the end of the current billing period.

Modes:

  • immediately: Status set to "canceled", access revoked now
  • period_end: cancelAtPeriodEnd flag set, access continues until period end

Related endpoints

  • POST /subscriptions — Create a new subscription
  • GET /subscriptions — List subscriptions
  • GET /subscriptions/{id} — Get subscription by ID
  • PATCH /subscriptions/{id} — Update subscription details
  • POST /subscriptions/{id}/change-plan — Change subscription plan
  • POST /subscriptions/{id}/preview-change-plan — Preview a plan change
  • POST /subscriptions/{id}/pause — Pause subscription
  • POST /subscriptions/{id}/resume — Resume subscription

Common errors

  • 400 invalid_request — malformed payload or failed validation.
  • 401 authentication_error — missing, invalid, expired, or revoked credential. Codes: authentication_failed, invalid_api_key, expired_api_key, api_key_revoked, session_invalid, merchant_required. Carries a WWW-Authenticate: Bearer challenge.
  • 404 resource_missing — the referenced resource does not exist or is not visible to your key.

Idempotency

Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.

Authorization

x-api-key<token>

Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.

In: header

Path Parameters

id*string

Subscription UUID

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Parameters for canceling a subscription, including whether to cancel immediately or at period end.

Response Body

application/json

application/json

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl -X POST "https://api.revkeen.com/v2/subscriptions/11111111-1111-4111-8111-111111111111/cancel" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "mode": "immediately"
  }'

Synthetic documentation data, validated against the response schema; not a live API result.

{  "data": {    "id": "d4e6f8a1-2b3c-4d5e-9f60-7a8b9c0d1e24",    "merchant_id": "8f14e45f-ceea-4e7a-9b4b-7c3f1a2d5e60",    "customer_id": "c2a1e7d4-5b3f-4a8e-9d21-6f0b3e4c7a11",    "product_id": "a7b3c9d2-1e4f-4b6a-8c5d-2f9e0a1b3c42",    "price_id": "b5d8e2f1-3a6c-4d9b-8e7f-1c4a2b5d6e73",    "plan_id": null,    "status": "active",    "quantity": 1,    "amount_minor": 4900,    "currency": "GBP",    "billing_interval": "month",    "current_period_start": "2026-04-16T10:00:00.000Z",    "current_period_end": "2026-05-16T10:00:00.000Z",    "trial_end": "2026-04-16T10:00:00.000Z",    "canceled_at": null,    "created_at": "2026-04-02T10:00:00.000Z",    "updated_at": "2026-04-02T10:05:00.000Z",    "dunning": null,    "payment_rail": "card",    "mandate_id": null,    "payment_method_id": "9e8d7c6b-5a4f-4e3d-8c2b-1a0f9e8d7c65"  },  "dd_collection_stopped": {    "open_invoice_ids": [      "string"    ],    "message": "string"  }}

Put this endpoint to work

Manage subscriptions