List subscriptions

GET

https://api.runledger.co/v1/subscriptions

GET

/v1/subscriptions

curl https://api.runledger.co/v1/subscriptions \
     -H "Authorization: Bearer <api_key>"

{
  "object": "string",
  "data": [
    {
      "id": "sub_5gT8hY1uIo",
      "object": "string",
      "customer": "string",
      "plan": "string",
      "status": "incomplete",
      "collection_method": "charge_automatically",
      "current_period_start": "2024-01-15T09:30:00Z",
      "current_period_end": "2024-01-15T09:30:00Z",
      "cancel_at_period_end": true,
      "metadata": {},
      "livemode": true,
      "created_at": "2024-01-15T09:30:00Z",
      "canceled_at": "2024-01-15T09:30:00Z",
      "scheduled_plan": "string",
      "overdraft_limit": "string",
      "credit_limit": {
        "amount": 1500,
        "currency": "usd"
      },
      "quantity": 1
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}

Authentication

AuthorizationBearer

A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.

Query parameters

customer_idstringOptional

Only objects belonging to this customer.

planstringOptional

Only subscriptions to this plan (ID or key).

statusenumOptional

Only subscriptions with this status.

Allowed values:

limitintegerOptional1-100Defaults to 20

Maximum number of objects to return, from 1 to 100.

cursorstringOptional

The next_cursor from the previous page.

Response

A page of subscriptions.

object"list"

datalist of objects

has_moreboolean

next_cursorstringOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

500

Internal Server Error