RevKeen Docs
Api reference

List subscriptions

Retrieve a paginated list of subscriptions with optional filters

Related endpoints

  • POST /subscriptions — Create a new subscription
  • GET /subscriptions/{id} — Get subscription by ID
  • PATCH /subscriptions/{id} — Update subscription details
  • DELETE /subscriptions/{id} — Delete subscription
  • POST /subscriptions/{id}/change-plan — Change subscription plan
  • POST /subscriptions/{id}/change-quantity — Change subscription quantity
  • POST /subscriptions/{id}/preview-renewal — Preview subscription renewal
  • POST /subscriptions/{id}/pause — Pause subscription

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
/subscriptions

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

page?integer

Page number

Default1
Range1 <= value
limit?integer

Maximum number of results (1-100)

Default20
Range1 <= value <= 100
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

curl "https://api.revkeen.com/v2/subscriptions" \  -H "x-api-key: $REVKEEN_API_KEY"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
      "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
      "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
      "priceId": "b245ceea-4bc7-4619-ae4c-559a1faf418e",
      "planId": "b3f60ba2-c1fd-4b3a-a23d-8e876e0ef75d",
      "status": "trialing",
      "quantity": 1,
      "amountMinor": 0,
      "currency": "str",
      "billingInterval": "day",
      "currentPeriodStart": "2019-08-24T14:15:22Z",
      "currentPeriodEnd": "2019-08-24T14:15:22Z",
      "trialEnd": "2019-08-24T14:15:22Z",
      "canceledAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "dunning": {
        "isInDunning": true,
        "phase": 0,
        "phaseLabel": "string",
        "phaseSeverity": "info",
        "retryCount": 0,
        "totalPossibleRetries": 0,
        "nextRetryAt": "2019-08-24T14:15:22Z",
        "daysInDunning": 0,
        "accessRestricted": true
      }
    }
  ],
  "pagination": {
    "page": 0,
    "limit": 0,
    "total": 0,
    "totalPages": 0
  }
}
Empty
Edit on GitHub