Authorization
string
required
Example:
Authorization | Bearer Paste-Your-API-Key-HereQuery Parameters
string
required
The unique identifier of the membership product whose tiers you want to list.
If missing or malformed the endpoint responds
400 "Invalid query parameters".integer
default:"10"
Number of items to return per page. Defaults to
10, with a maximum of 50.string
Cursor for forward pagination. Pass the
nextStartingAfter value from the
previous response (a Unix timestamp in milliseconds, as a string) to fetch the
next page.Response
Successful ResponseMain Structure (Root)
integer
Status code form API.
string
Status message that describes the status code.
array of object
List of membership tiers for the product.
boolean
Information on whether there is additional data to be retrieved (true/false).
string | null
Cursor to pass as
startingAfter to fetch the next page. null when there is
no further data.data Structure (Array Of Object)
string<uuid>
Unique identifier of the membership tier.
string
ISO 8601 timestamp (UTC) of when the tier was created.
string
HTML description of the tier.
string | null
Date the membership finishes, or
null when the tier has no fixed end.integer
Number of grace-period days after the next payment date.
boolean
Whether the tier has reached its member limit.
boolean
Whether a trial is available for the tier.
integer | null
Maximum number of members allowed on the tier, or
null when unlimited.string
Name of the membership tier.
string | null
Free-text notes for the tier.
boolean
Whether payment is collected at the start of the period.
string<uuid>
The product (payment link) ID the tier belongs to.
integer | null
Display position of the tier.
string
Redirect URL configured for the tier.
string
Current status of the tier (for example
ACTIVE).number | null
Trial credit granted, or
null when not applicable.integer
Number of trial days for the tier.
string
ISO 8601 timestamp (UTC) of the last update.
number | null
Upfront fee for joining the tier, or
null when none.string<uuid>
The user ID of the owner of the product.
Errors
object
Returned with
messages: "Invalid query parameters" when productId is missing
or the query parameters fail validation.