Authorization
Example:
Authorization | Bearer Paste-Your-API-Key-HereQuery Parameters
The unique identifier of the membership product whose members you want to list.
If missing or malformed the endpoint responds
400 "Invalid query parameters".Filter members by a search term (for example a customer name or email).
Start of the date range to filter by.
End of the date range to filter by.
When set, filters churned members. When this filter is used the response also
includes a
totalMember sibling field alongside data.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 members 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.Total number of members. Only present when the
isChurnedMember filter is used.data Structure (Array Of Object)
Each member row carries the membership-customer fields plus a few flattened, dotted-key columns for the related tier and customer.Unique identifier of the membership-customer record.
ISO 8601 timestamp (UTC) of when the member was created.
Unique identifier of the customer.
Unique identifier of the member’s tier.
ISO 8601 timestamp (UTC) of the member’s next scheduled payment.
Current status of the member (for example
active, inactive).ISO 8601 timestamp (UTC) of the last update.
The user ID of the owner of the product.
Public membership code of the member.
Name of the member’s tier (flattened dotted-key column).
Grace-period days of the member’s tier, as a string (flattened dotted-key column).
Name of the customer (flattened dotted-key column).
Mobile number of the customer (flattened dotted-key column).
Email address of the customer (flattened dotted-key column).
Errors
Returned with
messages: "Invalid query parameters" when productId is missing
or the query parameters fail validation.