List subscriptions | Prolifi

curl https://api.prolifi.co/api/v1/public/subscriptions \
     -H "Authorization: Bearer <token>"

{
  "data": [
    {
      "id": "string",
      "customer_id": "string",
      "plan_id": "string",
      "plan_name": "string",
      "status": "active",
      "billing_cycle": "string",
      "current_period_start": "2023-01-15",
      "current_period_end": "2023-01-15",
      "start_date": "2023-01-15",
      "billing_date": "2023-01-15",
      "cancel_at": "2024-01-15T09:30:00Z",
      "canceled_at": "2024-01-15T09:30:00Z",
      "pause_start": "2024-01-15T09:30:00Z",
      "pause_end": "2024-01-15T09:30:00Z",
      "pricing": {
        "amount": 1.1,
        "currency": "string",
        "pricing_scheme_id": "string"
      },
      "metadata": {},
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1,
    "has_more": true
  }
}

Returns a paginated list of subscriptions. Supports filtering by customer, status, and plan.

Authentication

AuthorizationBearer

Use a secret key (sk_test_* or sk_live_*) for full read/write access, or a public key (pk_test_* or pk_live_*) for read-only access.

Query parameters

limitintegerOptional1-100Defaults to 20

Maximum number of items to return (1-100).

offsetintegerOptional>=0Defaults to 0

Number of items to skip before returning results.

customer_idstringOptionalformat: "uuid"

Filter by customer UUID.

statusenumOptional

Filter by subscription status.

Allowed values:

plan_idstringOptionalformat: "uuid"

Filter by plan UUID.

Response

A paginated list of subscriptions

datalist of objects

paginationobject

Errors

401

Unauthorized Error