v1

latestOpenAPI 3.0.02026-07-263365201.7 KB

Plans

List plans

Retrieve all plans with cursor pagination

get/plans

Query parameters

cursorstring nullable

limitnumber

filter[field][operator]string nullable

Filterable fields:

status (string)
created_at (date)

See Filtering Documentation for supported operators and syntax.

Example:value

Filterable fields:

status (string)
created_at (date)

See Filtering Documentation for supported operators and syntax.

Response

Retrieve all plans with cursor pagination

object'list' required

next_pagestring nullable

has_moreboolean

Example response

{
  "items": [
    {
      "id": "pln_bn1sny3aczwq5jkz8xcf4klf",
      "name": "Nomos Friends & Family",
      "slug": "nomos",
      "description": "A plan for friends and family",
      "price": 10.99,
      "currency": "EUR",
      "created_at": "2021-01-01T00:00:00.000Z",
      "type": "consumption"
    }
  ],
  "next_page": "eyJsYXN0X2NyZWF0ZWRfYXQiOiIyMDI1LTAxLTE1VDEwOjMwOjAwLjAwMFoiLCJsYXN0X2lkIjoic3ViX21pNGYwb2RhNng5bTdnY3N2amswb2xlMSIsImxpbWl0IjoyMH0="
}