RevKeenDocs
StatusSupport
API Reference
📋 Billing & SubscriptionsSubscriptions

List subscriptions

Retrieve a paginated list of subscriptions with optional filters.

GET/subscriptions

Retrieve a paginated list of subscriptions with optional filters.

Every query parameter is optional: a bare call lists the merchant's subscriptions, newest first, with a default page size of 20. customerId must name a customer of the authenticated merchant; an unknown id is rejected with 404 resource_missing rather than returning an empty list, so a mistyped filter is not mistaken for a customer who has no subscriptions.

Related endpoints

  • POST /subscriptions — Create a new subscription
  • 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
  • POST /subscriptions/{id}/cancel — Cancel subscription

Common errors

  • 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.

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.

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

Query Parameters

page?integer

Page number

Range1 <= value
Default1
limit?integer

Maximum number of results (1-100)

Range1 <= value <= 100
Default20
status?string

Filter by subscription status

Value in

  • "active"
  • "canceled"
  • "past_due"
  • "trialing"
  • "paused"
  • "incomplete"
  • "incomplete_expired"
customerId?string

Filter by customer UUID

Formatuuid

Response Body

application/json

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl -X GET "https://api.revkeen.com/v2/subscriptions?page=1&limit=20" \
  -H "x-api-key: $REVKEEN_API_KEY"

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"    }  ],  "pagination": {    "page": 1,    "limit": 20,    "total": 42,    "totalPages": 3  }}

Put this endpoint to work

Manage subscriptions