Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-07-20"

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,
expiration_days
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