RevKeenDocs
StatusSupport
API Reference
Customer Portal

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.

GET/customer-portal/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
  • GET /customer-portal/mandates — List the authenticated customer's Direct Debit mandates
  • POST /customer-portal/mandates/{id}/re-authorize — Re-authorise a Direct Debit mandate with new bank details

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.

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

limit?integer

Maximum number of results to return (1-100, default 20).

Range1 <= value <= 100
Default20
starting_after?string

Cursor — return results created before the row with this ID.

Formatuuid
ending_before?string

Cursor — return results created after the row with this ID.

Formatuuid

Response Body

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/customer-portal/subscriptions?limit=20&starting_after=11111111-1111-4111-8111-111111111111" \
  -H "Authorization: Bearer $REVKEEN_PORTAL_TOKEN"

Synthetic documentation data, validated against the response schema; not a live API result.

{  "object": "list",  "data": [    {      "id": "d4e6f8a1-2b3c-4d5e-9f60-7a8b9c0d1e24",      "object": "subscription",      "status": "active",      "currency": "GBP",      "amount_minor": 4900,      "interval": "month",      "interval_count": 1,      "billing_end_strategy": "indefinite",      "billing_max_cycles": null,      "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",      "cancel_at": null,      "canceled_at": null,      "started_at": "2026-04-02T10:00:00.000Z",      "created_at": "2026-04-02T10:00:00.000Z"    }  ],  "has_more": false,  "url": "/v2/customer-portal/subscriptions"}

Put this endpoint to work

Manage customers