RevKeen Docs
Api reference

List subscription schedules

Returns a list of subscription schedules with optional filters.

Related endpoints

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

Common errors

  • 401 unauthenticated — missing, malformed, or revoked API key.

Pagination

Offset-based with limit (default 25, max 100) and offset. The response pagination block includes total and hasMore. See the pagination guide for SDK auto-paging helpers.

GET
/subscription-schedules

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

Query Parameters

customer?string

Filter by customer ID

Formatuuid
subscription?string

Filter by subscription ID

Formatuuid
status?string

Filter by status

Value in"not_started" | "active" | "completed" | "canceled" | "released"
scheduled_gte?|

Start date >= (Unix timestamp)

scheduled_lte?|

Start date <= (Unix timestamp)

limit?integer

Max results (1-100)

Default20
Range1 <= value <= 100
starting_after?string

Cursor - return results after this ID

ending_before?string

Cursor - return results before this ID

Response Body

application/json

application/json

curl "https://api.revkeen.com/v2/subscription-schedules" \  -H "x-api-key: $REVKEEN_API_KEY"
{
  "object": "list",
  "data": [
    {
      "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
    }
  ],
  "has_more": true,
  "url": "string"
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string"
  }
}
Edit on GitHub