Skip to main content
GET
List plans

Autorisierungen

Authorization
string
header
erforderlich

Organisation API token. Send it as Authorization: Bearer api_... The token is scoped to a single Organisation.

Abfrageparameter

status
enum<string>

Lifecycle status. A plan is created as draft, becomes active once you activate it, and can later be archived. Only active plans can be sold or switched into.

Verfügbare Optionen:
draft,
active,
archived
code
string

Filter by a code substring.

sort
enum<string>
Verfügbare Optionen:
updatedAt,
createdAt,
code,
name
order
enum<string>
Verfügbare Optionen:
asc,
desc
cursor
string
limit
integer
Standard:20
page
integer

Switches to page based pagination.

Antwort

A paginated list of plans.

data
object[]
meta
object
pagination
object

Pagination metadata. Cursor based fields are present for the default cursor mode, page based fields are present when you pass page or offset.