Skip to main content
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 through GET /api/public/teams/{teamId}/benefits/history.

Authentication

Requires a valid customer bearer token.

Query Parameters

string
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.
string
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.
number
default:"1"
Page number, starting at 1.
number
default:"25"
Number of records per page.
string
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.
BenefitUsageRecord[]
required
The uses on the requested page.
string
Unique across sources: credit-use-{id}, service-use-{id}, credit-expired-{id} or service-expired-{id}.
string
"BookingTime", "Credit" or "Printing".
string
Name of the benefit that was used.
string | null
Start of the benefit’s validity period, in the location’s time zone.
string | null
End of the benefit’s validity period, in the location’s time zone. null when the benefit does not expire.
string | null
First day of the month the benefit was issued for. The portal groups rows by it (“Credit issued for July 2026”).
number
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.
string
"Minutes", "Days", "Weeks", "Months", "Uses" or "Money".
string | null
Currency of Amount. Only set when Unit is "Money".
number | null
Customer who used the benefit. null when not recorded and on "Expired" rows.
string | null
Full name of the customer who used the benefit.
string
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).
string | null
Name of what the benefit was used for, such as the booked resource or the event.
string
When the benefit was used, in UTC. For an "Expired" row, the expiry date.
string | null
End of the use, in UTC, such as the end of a booking.
array
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.
array
Always empty for this endpoint.

Example Response

Usage in Portal

Error Responses

error
kind is not BookingTime, Credit or Printing.
error
The bearer token is missing, expired, or invalid.