Skip to main content
GET
/
plans
List Plans
curl --request GET \
  --url https://{defaultHost}/plans \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "visibility": "<string>",
      "plan_type": "<string>",
      "release_method": "<string>",
      "currency": "<string>",
      "account": {},
      "product": {},
      "invoice": {},
      "billing_period": 123,
      "title": "<string>",
      "description": "<string>",
      "purchase_url": "<string>",
      "expiration_days": 123,
      "initial_price": 123,
      "renewal_price": 123,
      "trial_period_days": 123,
      "three_ds_level": "<string>",
      "member_count": 123,
      "internal_notes": "<string>",
      "metadata": {},
      "stock": 123,
      "unlimited_stock": true,
      "split_pay_required_payments": 123,
      "adaptive_pricing_enabled": true,
      "payment_method_configuration": {}
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token.

Headers

Api-Version-Date
string<date>

Pins the request to a dated API version. When omitted, the request uses the original (2025-01-01) request/response shapes, so existing unversioned callers are never broken. Generated SDKs always send the latest version they were built against. An unrecognized value is rejected with a 400. The schemas documented here always describe the latest version.

Example:

"2026-06-09"

Query Parameters

account_id
string
required

The unique identifier of the account to list plans for.

direction
enum<string>

The sort direction for results. Defaults to descending.

Available options:
asc,
desc
order
enum<string>

The field to sort results by. Defaults to created_at.

Available options:
id,
active_members_count,
created_at,
internal_notes,
expires_at
release_methods
string[]

Filter to only plans matching these release methods.

visibilities
string[]

Filter to only plans matching these visibility states.

plan_types
string[]

Filter to only plans matching these billing types.

product_ids
string[]

Filter to only plans belonging to these product identifiers.

created_before
string

Only return plans created before this timestamp.

created_after
string

Only return plans created after this timestamp.

first
integer

The number of plans to return (default and max 100).

after
string

A cursor; returns plans after this position.

last
integer

The number of plans to return from the end of the range.

before
string

A cursor; returns plans before this position.

Response

plans listed

data
object[]
required
page_info
object
required