> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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 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](https://learn.nexudus.com/member-portal/dashboard/my-plans.md) 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`](https://learn.nexudus.com/api/endpoints/teams/team-benefits-history).

## Authentication

Requires a valid customer bearer token.

## Query Parameters

**kind** `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.

**benefit** `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`.

**page** `number` (default: 1)

Page number, starting at 1.

**size** `number` (default: 25)

Number of records per page.

**\_shape** `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.

**Records** `BenefitUsageRecord[]` *required*

The uses on the requested page.

**Records\[].Id** `string`

Unique across sources: `credit-use-{id}`, `service-use-{id}`, `credit-expired-{id}` or `service-expired-{id}`.

**Records\[].Kind** `string`

`"BookingTime"`, `"Credit"` or `"Printing"`.

**Records\[].BenefitName** `string`

Name of the benefit that was used.

**Records\[].ValidFrom** `string | null`

Start of the benefit's validity period, in the location's time zone.

**Records\[].ValidTo** `string | null`

End of the benefit's validity period, in the location's time zone. `null` when the benefit does not expire.

**Records\[].IssuedFor** `string | null`

First day of the month the benefit was issued for. The portal groups rows by it ("Credit issued for July 2026").

**Records\[].Amount** `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.

**Records\[].Unit** `string`

`"Minutes"`, `"Days"`, `"Weeks"`, `"Months"`, `"Uses"` or `"Money"`.

**Records\[].CurrencyCode** `string | null`

Currency of `Amount`. Only set when `Unit` is `"Money"`.

**Records\[].UsedById** `number | null`

Customer who used the benefit. `null` when not recorded and on `"Expired"` rows.

**Records\[].UsedByFullName** `string | null`

Full name of the customer who used the benefit.

**Records\[].UsedForType** `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).

**Records\[].UsedForName** `string | null`

Name of what the benefit was used for, such as the booked resource or the event.

**Records\[].UsedFromUtc** `string`

When the benefit was used, in UTC. For an `"Expired"` row, the expiry date.

**Records\[].UsedToUtc** `string | null`

End of the use, in UTC, such as the end of a booking.

**Filters.Benefits** `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.

**Filters.Members** `array`

Always empty for this endpoint.

## Example Response

```json theme={null}
{
  "Records": [
    {
      "Id": "service-use-8812",
      "Kind": "BookingTime",
      "BenefitName": "Meeting room hours",
      "ValidFrom": "2026-07-01T00:00:00",
      "ValidTo": "2026-07-31T23:59:59",
      "IssuedFor": "2026-07-01T00:00:00",
      "Amount": 60,
      "Unit": "Minutes",
      "CurrencyCode": null,
      "UsedById": 1042,
      "UsedByFullName": "Alex Morgan",
      "UsedForType": "Booking",
      "UsedForName": "Meeting Room 2",
      "UsedFromUtc": "2026-07-14T09:00:00Z",
      "UsedToUtc": "2026-07-14T10:00:00Z"
    },
    {
      "Id": "service-expired-311",
      "Kind": "BookingTime",
      "BenefitName": "Meeting room hours",
      "ValidFrom": "2026-06-01T00:00:00",
      "ValidTo": "2026-06-30T23:59:59",
      "IssuedFor": "2026-06-01T00:00:00",
      "Amount": 120,
      "Unit": "Minutes",
      "CurrencyCode": null,
      "UsedById": null,
      "UsedByFullName": null,
      "UsedForType": "Expired",
      "UsedForName": null,
      "UsedFromUtc": "2026-06-30T22:59:59Z",
      "UsedToUtc": null
    }
  ],
  "CurrentPage": 1,
  "PageSize": 25,
  "TotalItems": 2,
  "TotalPages": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "Filters": {
    "Benefits": [{ "Name": "Meeting room hours", "Kind": "BookingTime" }],
    "Members": []
  }
}
```

## Usage in Portal

| Context | Source file |
| - | - |
| Data hook | `src/views/user/plans/useBenefitUsageHistoryData.ts` |
| History section component | `src/views/user/plans/components/BenefitUsageHistorySection.tsx` |

## Error Responses

**400 Bad Request** `error`

`kind` is not `BookingTime`, `Credit` or `Printing`.

**401 Unauthorized** `error`

The bearer token is missing, expired, or invalid.

## Related Endpoints

| Method | Endpoint | Description |
| - | - | - |
| `GET` | [`/api/public/coworkers/profiles/current/benefits`](https://learn.nexudus.com/api/endpoints/coworkers/customer-benefits) | Current benefits of the customer |
| `GET` | [`/api/public/teams/{teamId}/benefits/history`](https://learn.nexudus.com/api/endpoints/teams/team-benefits-history) | Credit use history of all members of a team |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.