Skip to main content
GET
List purchasable membership offerings
This endpoint is in beta: its request and response contract can still change while it’s being developed.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page[size]
number | null

How many results to return per page, from 1 to 500. Defaults to 100.

Required range: 1 <= x <= 500
Example:

100

page[after]
string | null

Pass page.next from the previous response to get the next page.

page[before]
string | null

Pass page.prev from the previous response to get the previous page.

schemeId
string
required

The id of one of your membership schemes.

Pattern: ^[a-fA-F0-9]{24}$

Response

A page of the offerings on sale in the scheme, each with its current price.

data
MembershipOffering · object[]
required
page
PageCursor · object
required

Where you are in a paginated list.

Pass next as page[after] to get the next page, or prev as page[before] to get the previous one. An empty cursor means there are no more pages in that direction. Treat cursors as opaque strings.

Example: