Sign in
Reports

Queue an export of the membership credit usage report

This endpoint queues an export of the membership credit usage report.

get/shop/reports/membership-credit-usage/queue

Query parameters

site_idstring uuid

Restrict the report to membership credits associated with the given site. Omit to include credits across every site the caller's API key can access; the response groups them under their own site_id field.

'redeemable' | 'redeemed' | 'revoked' | 'expired'
OR
string[]

Filter credits by their computed status. Supports a single value or an array of values.

membership_type_idstring uuid

Filter credits by the membership type.

membership_status'active' | 'inactive' | 'expired' | 'upcoming' | 'needs_attention' | 'reserved'

Filter credits by the current status of the associated membership.

multi_useboolean

Filter credits by whether they are multi-use.

issued_at_fromstring date
Example:2026-01-01

Filter credits issued on or after this date. The date is interpreted in the site's local timezone.

issued_at_tostring date
Example:2026-03-31

Filter credits issued on or before this date. The date is interpreted in the site's local timezone.

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

No recorded changes to this endpoint across all 1 revision of this API.