Subscriptions

Get all subscriptions

get/subscriptions

Request

Query parameters

pageinteger

Page number

per_pageinteger

Number of records per page

external_customer_idstring
Example:ext_cus_1234567890abcdef

Filter by external customer ID

plan_codestring
Example:plan_1234567890abcdef

Filter by plan code

statusstring[]

Comma-separated list of statuses

Response

A list of subscriptions

Example response

{
  "subscriptions": [
    {
      "name": "Subscription_1",
      "start_date": "2025-06-01T00:00:00Z",
      "end_date": "2028-01-01T00:00:00Z",
      "external_customer_id": "client-jkl101",
      "external_id": "SUB_1752779018503",
      "plan_code": "Plan-Code-1753840215",
      "billing_time": "CALENDAR",
      "id": "b71befc2-4799-402c-9d13-ca1f72759c64",
      "status": "ACTIVE",
      "plan_overrides": {
        "amount": {
          "value": 120.35,
          "currency_code": "USD"
        },
        "description": "Plan for early stage startups",
        "invoice_display_name": "Startup plan",
        "name": "Startup",
        "charges": [
          {
            "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
            "charge_model": "GRADUATED",
            "taxes": [
              {
                "name": "TVA",
                "rate": "20.00",
                "description": "French standard VAT",
                "code": "standard_vat",
                "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
                "created_at": "2025-06-01T00:00:00Z"
              }
            ],
            "min_amount": {
              "value": 120.35,
              "currency_code": "USD"
            }
          }
        ],
        "minimum_commitment": {
          "amount": {
            "value": 120.35,
            "currency_code": "USD"
          },
          "invoice_display_name": "Minimum Commitment (C1)",
          "taxes": [
            {
              "name": "TVA",
              "rate": "20.00",
              "description": "French standard VAT",
              "code": "standard_vat",
              "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
              "created_at": "2025-06-01T00:00:00Z"
            }
          ],
          "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
          "plan_code": "premium",
          "created_at": "2022-04-29T08:59:51Z",
          "updated_at": "2022-04-29T08:59:51Z"
        },
        "chargeUsage": [
          {
            "id": "545-1a90-1a90-1a90-1a90-1a901a901a90",
            "recurring": "true",
            "threshold_display_name": "Startup",
            "created_at": "2023-10-01T12:00:00Z",
            "updated_at": "2023-10-01T12:00:00Z",
            "amount": {
              "value": 120.35,
              "currency_code": "USD"
            }
          }
        ],
        "taxes": [
          {
            "name": "TVA",
            "rate": "20.00",
            "description": "French standard VAT",
            "code": "standard_vat",
            "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
            "created_at": "2025-06-01T00:00:00Z"
          }
        ],
        "trial_period": 5
      },
      "canceled_at": "2025-01-01T00:00:00Z",
      "terminated_at": "2025-01-01T00:00:00Z",
      "current_period_start": "2025-05-01T00:00:00Z",
      "current_period_end": "2023-10-01T12:00:00Z",
      "trial_ended_at": "2025-05-01T00:00:00Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.