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