Sign in
Reports

List course credits

Use this endpoint to retrieve a paginated list of individual course credit records, including their current status (redeemable, redeemed, revoked, or expired), the customer and course they belong to, key dates, and their monetary value. Course credits are customer credits issued from a course purchase at the given site. Totals summarise the outstanding and redeemed value of the matched credits so a site can reconcile its course-credit liability.

get/shop/reports/course-credits

Query parameters

site_idstring uuid required

Restrict the report to course credits belonging to the given site. Required, as the report resolves the site's course types to determine which credits to include.

course_type_idstring object-id

Filter credits by the course type they were purchased from.

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

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

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": "10 Session PT Package"
      },
      "first_name": "John",
      "last_name": "Doe",
      "course": {
        "name": "Personal Training Package"
      },
      "value": 5000
    }
  ],
  "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,
    "outstanding_value": 375000,
    "redeemed_value": 225000,
    "currency": "GBP"
  }
}

Changes

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