RevKeen Docs
Api reference

List the authenticated customer's subscriptions

Returns subscriptions where the customer is the subscriber. Results are reverse-chronological by creation time and paginate via starting_after / ending_before cursors.


Related endpoints

  • POST /customer-portal/sessions — Create a customer-portal session
  • GET /customer-portal/customer — Retrieve the authenticated customer
  • GET /customer-portal/subscriptions/{id} — Retrieve a subscription
  • POST /customer-portal/subscriptions/{id}/cancel — Cancel a subscription
  • GET /customer-portal/invoices — List the authenticated customer's invoices
  • GET /customer-portal/invoices/{id} — Retrieve an invoice

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

limit?integer
Default20
Range1 <= value <= 100
starting_after?string
Formatuuid
ending_before?string
Formatuuid

Response Body

application/json

application/json

curl "https://api.revkeen.com/v2/customer-portal/subscriptions" \  -H "x-api-key: $REVKEEN_API_KEY"
{
  "object": "list",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "object": "subscription",
      "status": "string",
      "currency": "string",
      "amount_minor": 0,
      "interval": "string",
      "interval_count": 0,
      "current_period_start": "2019-08-24T14:15:22Z",
      "current_period_end": "2019-08-24T14:15:22Z",
      "trial_end": "2019-08-24T14:15:22Z",
      "cancel_at": "2019-08-24T14:15:22Z",
      "canceled_at": "2019-08-24T14:15:22Z",
      "started_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ],
  "has_more": true,
  "url": "string"
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}