Sign in
Memberships

Queue a report of memberships

Retrieves a report of memberships in CSV format. The report will be generated asynchronously.

get/customers/memberships/queue

Query parameters

customer_idstring uuid

Filters memberships belonging to the specified customer

site_idstring

The site ID to filter against

statusstring[]

The status of the membership

membership_type_idstring uuid

Deprecated. Use membership_type_ids instead.

membership_type_idsstring[]

The membership type IDs to filter against. Separate multiple IDs with a comma.

membership_rate_idsstring[]

Restrict the result to memberships on the given membership rates. Pass one or more MembershipRate IDs separated by commas. When omitted, all rates are returned.

created_at_fromstring date

Filter memberships created no earlier than the given date

created_at_tostring date

Filter memberships created no later than the given date

next_billing_date_fromstring date

Filter memberships due for billing no earlier than the given date

next_billing_date_tostring date

Filter memberships due for billing no later than the given date

end_date_fromstring date

Filter memberships that end no earlier than the given date

end_date_tostring date

Filter memberships that end no later than the given date

attention_reasonstring

The reason why this membership needs attention

manual_paymentsboolean

Whether to only show membership types that have auto-payments disabled

membership_numberstring

The membership number to filter against

external_refstring

The external reference to filter against

billing_frequencystring[]

The membership billing frequency to filter against

Response

The job was successfully queued

Example response

{
  "data": {
    "created_at": "2023-11-07T00:00:00+00:00",
    "updated_at": "2023-11-07T01:00:00+00:00"
  }
}

Changes