RevKeen Docs
Api reference

Cancel a subscription schedule

Cancels a subscription schedule. Only schedules in 'not_started' or 'active' status can be canceled.

Related endpoints

  • POST /subscription-schedules — Create a subscription schedule
  • GET /subscription-schedules — List subscription schedules
  • GET /subscription-schedules/{id} — Retrieve a subscription schedule
  • POST /subscription-schedules/{id} — Update a subscription schedule
  • POST /subscription-schedules/{id}/release — Release a subscription schedule

Common errors

  • 400 invalid_request — malformed payload or failed validation.
  • 401 unauthenticated — missing, malformed, or revoked API key.
  • 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.

POST
/subscription-schedules/{id}/cancel

Authorization

x-api-key<token>

Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.

In: header

Path Parameters

id*string

Schedule ID (sub_sched_xxx or UUID)

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://api.revkeen.com/v2/subscription-schedules/string/cancel" \  -H "x-api-key: $REVKEEN_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "invoice_now": false,    "prorate": false  }'
{
  "id": "string",
  "object": "subscription_schedule",
  "status": "not_started",
  "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  "subscription": "da7489c5-d730-47b7-9958-07300ef9d3d8",
  "current_phase": {
    "start_date": 0,
    "end_date": 0
  },
  "phases": [
    {
      "items": [
        {
          "price_id": "5eff5d89-979e-4e4f-aa76-6cbbbf11362c",
          "quantity": 1
        }
      ],
      "start_date": "2026-03-01T00:00:00Z",
      "end_date": "2026-06-01T00:00:00Z",
      "proration_behavior": "create_prorations",
      "billing_cycle_anchor": "string",
      "default_payment_method": "ef3a4459-d1f8-4959-ac0e-6345ea87aaf5",
      "collection_method": "charge_automatically",
      "coupon": "string",
      "trial_end": "string",
      "metadata": {}
    }
  ],
  "end_behavior": "cancel",
  "released_at": 0,
  "released_subscription": "d4d0aecc-c2f2-4fb2-b3fc-45d324d3f58f",
  "metadata": {},
  "created": 0,
  "livemode": true
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string"
  }
}
Edit on GitHub