memberships_list
Returns a page of customer membership records filtered by customer/membership IDs, status, active state, billing frequency, duration, and timestamps. Use for searching or auditing sold memberships.
Instructions
List one requested page of customer membership records using membership and customer IDs, status, active state, billing frequency, duration, and created or modified timestamps. Use memberships_get for one known sold membership and memberships_types_list for reusable membership-plan definitions.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | Comma-separated membership IDs (maximum 50) | |
| page | No | Page number (starts at 1) | |
| active | No | Filter by active status | True |
| status | No | Filter by membership status | |
| duration | No | Filter by membership duration in months | |
| pageSize | No | Records per page (default 50) | |
| customerIds | No | Comma-separated customer IDs | |
| includeTotal | No | Include total count in response | |
| createdBefore | No | ||
| modifiedBefore | No | ||
| billingFrequency | No | Filter by membership billing frequency | |
| createdOnOrAfter | No | ||
| modifiedOnOrAfter | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||