Skip to main content
GET
/
api
/
v1
/
subscriptions
List subscriptions
curl --request GET \
  --url https://api.example.com/api/v1/subscriptions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "auto_advance_invoices": true,
      "billing_day_anchor": 123,
      "charge_automatically": true,
      "created_at": "2023-11-07T05:31:56Z",
      "currency": "AED",
      "current_period_start": "2023-12-25",
      "customer_id": "<string>",
      "customer_name": "<string>",
      "id": "<string>",
      "mrr_cents": 1,
      "net_terms": 1,
      "period": "MONTHLY",
      "plan_id": "<string>",
      "plan_name": "<string>",
      "plan_version": 1,
      "plan_version_id": "<string>",
      "start_date": "2023-12-25",
      "status": "PENDING_ACTIVATION",
      "activated_at": "2023-11-07T05:31:56Z",
      "billing_start_date": "2023-12-25",
      "current_period_end": "2023-12-25",
      "customer_alias": "<string>",
      "end_date": "2023-12-25",
      "invoice_memo": "<string>",
      "payment_methods_config": {
        "type": "online",
        "config": {
          "card": {
            "enabled": true
          },
          "direct_debit": {
            "enabled": true
          }
        }
      },
      "plan_description": "<string>",
      "purchase_order": "<string>",
      "trial_duration": 1
    }
  ],
  "pagination_meta": {
    "page": 1,
    "per_page": 1,
    "total_items": 1,
    "total_pages": 1
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

customer_id
string

Filter by customer ID or alias

plan_id
string<MeteroidId>
Example:

"plan_7n42DGM5Tflk9n8mt7Fhc7"

statuses
enum<string>[]
Available options:
PENDING_ACTIVATION,
PENDING_CHARGE,
TRIAL_ACTIVE,
ACTIVE,
TRIAL_EXPIRED,
PAUSED,
SUSPENDED,
CANCELLED,
COMPLETED,
SUPERSEDED,
ERRORED
page
integer<int32>

Page number (0-indexed)

Required range: x >= 0
per_page
integer<int32>

Number of items per page

Required range: 1 <= x <= 100

Response

List of subscriptions

data
object[]
required
pagination_meta
object
required