POST

List Eligible Memberships


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

This method retrieves eligible memberships from your app.

Endpoint
POST
{DEPLOYMENT-URI}/v1/list-eligible-memberships
Body Params
lineItemsArray <LineItem>RequiredminItems 1maxItems 300

The line items for which to list eligible memberships.


memberIdstringRequiredformat GUID

Member ID.

Do not retrieve this from the request context. In some cases the caller is not a member, but a user who is using the membership on behalf of a member.


selectedMembershipsSelectedMemberships

The selected payment memberships and which line items they apply to.

When not provided, your implementation is expected to return the default selection. When provided, your implementation is expected to validate and return it.

Response Object
eligibleMembershipsArray <Membership>maxItems 300

List of memberships that are eligible for the given member and line items.


invalidMembershipsArray <InvalidMembership>maxItems 300

List of memberships owned by the member, but cannot be used due to the reason provided.


selectedMembershipsArray <SelectedMembership>maxItems 300

List of selected memberships and which line items they apply to.

List Eligible Memberships

Get list of all member's memberships, that are applicable for given line item.

Request
cURL
Response
JSON
Errors
InvalidSelectionobjectstatus code: 400
Did this help?