Reports

List membership credit usage

Use this endpoint to retrieve a paginated list of individual membership credit records, including their current status (redeemable, redeemed, revoked, or expired), the associated customer and membership details, and issuance/expiry dates. Unlike the membership credits summary report, this report returns one row per credit rather than aggregating by membership.

get/shop/reports/membership-credit-usage

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'

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.

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.

sortstring

The field to sort the results by.

sort_direction'asc' | 'desc'

The direction to sort the results in.

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

Response

The list of items was successfully retrieved

Example response

{
  "data": [
    {
      "coupon": {
        "name": "Spa Day Pass"
      },
      "first_name": "John",
      "last_name": "Doe",
      "membership": {
        "number": "47569",
        "type_name": "Gold Membership"
      }
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  },
  "totals": {
    "total_credits": 150,
    "total_redeemed": 45,
    "total_revoked": 10,
    "total_expired": 20,
    "total_redeemable": 75,
    "total_multi_use": 30
  }
}

Changes

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