Customers & Directory
Get Customer Credit Use History
Retrieve a paged history of how the current customer used their booking time, money credit and printing credit, including credit lost on expiry.
GET
Get Customer Credit Use History
Get Customer Credit Use History
Returns a paged list of the current customer’s benefit uses: booking time, money credit and printing credit. Each benefit that expired with credit left adds a row for the credit that was lost. The portal uses this for the Booking time and credit use history section on the My Plans page, and on the team Benefits page for customers who aren’t team administrators. Only the customer’s own uses are returned. Uses of a shared benefit by other team members are left out; team administrators see them throughGET /api/public/teams/{teamId}/benefits/history.
Authentication
Requires a valid customer bearer token.Query Parameters
The kind of benefit to return:
"BookingTime", "Credit" or "Printing" (case-insensitive). Leave it out to return every kind together. Any
other value returns 400 Bad Request. Passes have no use history.Only return uses of benefits with this name. Benefits are filtered by name because recurring benefits are issued as separate records with the
same name. Use a value from
Filters.Benefits[].Name.Comma-separated list of field paths to include in the response. When provided, only the
specified fields are returned — useful for reducing payload size. Supports nested paths
using dot notation.
Response
A standard paged list (Records, CurrentPage, PageSize, TotalItems, TotalPages, HasNextPage, HasPreviousPage and the other paging
fields) plus the filter options. Records are sorted by IssuedFor, then UsedFromUtc, both newest first. There is no date limit.
Unique across sources:
credit-use-{id}, service-use-{id}, credit-expired-{id} or service-expired-{id}.End of the benefit’s validity period, in the location’s time zone.
null when the benefit does not expire.First day of the month the benefit was issued for. The portal groups rows by it (“Credit issued for July 2026”).
Amount used, in
Unit. Negative when credit was added back (UsedForType is "Added"). For an "Expired" row, the credit that was left when
the benefit expired.What the benefit was used for:
"Booking", "Event", "Printing", "Other", "Added" (credit added back, for example by an adjustment) or
"Expired" (credit lost when the benefit expired).Every benefit with at least one use, as
{ Name, Kind }. Built before kind and benefit are applied, so the options don’t change with the
filter. The portal uses the kinds listed here to decide which tabs to show.