v1

latestOpenAPI 3.0.02026-07-263365201.7 KB

Subscriptions

List subscriptions

Retrieve all subscriptions

get/subscriptions

Query parameters

cursorstring nullable

limitnumber

filter[field][operator]string nullable

Filterable fields:

status (enum): pending, active, ended
customer (string)
plan (string)
created_at (date)
updated_at (date)

See Filtering Documentation for supported operators and syntax.

Example:value

Filterable fields:

status (enum): pending, active, ended
customer (string)
plan (string)
created_at (date)
updated_at (date)

See Filtering Documentation for supported operators and syntax.

Response

Retrieve all subscriptions

object'list' required

next_pagestring nullable

has_moreboolean

Example response

{
  "items": [
    {
      "id": "sub_rocbrf1u5e48mm0reeqoag90",
      "plan": "pln_ctj3tjzc7dywznuw1dy80lb3",
      "customer": "cus_a8n8ol7yd4h0wohx824f0bui",
      "address": "adr_a7gurqkul8lzzsy1pf9p9388",
      "meter": "mtr_azk4zue2ijx4ff1dbjt14m5h",
      "payment_method": "pm_adc9utqqpcp7tx054l7vg56s2",
      "supplier": "mp_a0x6jm5h92wde6s5dnuvha4c",
      "number": "4X44EMKX",
      "status": "active",
      "metadata": {
        "utm_source": "google",
        "utm_campaign": "campaign_name",
        "user_id": "1234567890"
      },
      "type": "consumption",
      "billing_address": "adr_a7gurqkul8lzzsy1pf9p9388"
    }
  ],
  "next_page": "eyJsYXN0X2NyZWF0ZWRfYXQiOiIyMDI1LTAxLTE1VDEwOjMwOjAwLjAwMFoiLCJsYXN0X2lkIjoic3ViX21pNGYwb2RhNng5bTdnY3N2amswb2xlMSIsImxpbWl0IjoyMH0="
}