Search ProductBookingCredits

Search and list ProductBookingCredit records with filtering, sorting, and pagination.

GET /api/billing/productbookingcredits

Search ProductBookingCredits

cURL

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/productbookingcredits \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

A ProductBookingCredit represents an amount of credit linked to a Product. When a customer purchases the product, the credit is automatically released as a CoworkerBookingCredit on the customer’s account.

Credit can be configured for two primary uses:

• Bookings — set CaneBeUsedForBookings to allow the credit to pay for bookings. Use ElegibleResourceTypes to restrict the credit to specific resource types; if left empty the credit is valid for all resource types.
• Events — set CaneBeUsedForEvents to allow the credit to pay for event sign-ups. Use EventCategories to restrict to specific event categories; if left empty the credit is valid for all events.

Setting IsUniversalCredit enables the credit for products, time passes, and other charges. Use ElegibleProducts, ElegiblePasses, and AppliesToCharges to restrict which products or passes the credit is valid for. If all restriction lists are empty the universal credit applies to all products, passes and charges.

Use ExpirationType and ExpiresIn to control when the released credit expires.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the ProductBookingCredit-List role.

Enums

eRecurrentChargePattern

Value	Name
1	PricePlan
2	Day
3	Week
4	Month
5	Year
6	LastDayOfMonth

Query Parameters

Pagination & Sorting

page · integer · default: "1"

The page number to retrieve.

size · integer · default: "25"

The number of records per page.

orderBy · string

The property name to sort results by (e.g. Name, CreatedOn).

dir · integer

Sort direction. 0 for ascending, 1 for descending.

Filters

ProductBookingCredit_Name · string

Filter by credit name.

ProductBookingCredit_Product · integer

Filter by iD of the product linked to this record.

ProductBookingCredit_Product_Name · string

Filter by product name.

ProductBookingCredit_Product_Business_Currency_Code · string

Filter by product business currency code.

ProductBookingCredit_Credit · number

Filter by credit amount.

ProductBookingCredit_ExpireTimeInMonths · integer

Filter by the expire time in months value for this product booking credit.

ProductBookingCredit_ExpireTimeInWeeks · integer

Filter by the expire time in weeks value for this product booking credit.

ProductBookingCredit_CaneBeUsedForBookings · boolean

Filter by whether this credit can be used to pay for bookings. Restrict to specific resource types with ElegibleResourceTypes.

ProductBookingCredit_CaneBeUsedForEvents · boolean

Filter by whether this credit can be used to pay for event sign-ups. Restrict to specific categories with EventCategories.

ProductBookingCredit_ExpirationType · integer

Filter by expiration type.

ProductBookingCredit_ExpiresIn · integer

Filter by number of periods (of ExpirationType) until the released credit expires.

ProductBookingCredit_IsUniversalCredit · boolean

Filter by whether this is a universal credit applicable to products, time passes and other charges. Restrict with ElegibleProducts, ElegiblePasses and AppliesToCharges; if all are empty the credit applies to all products, passes and charges.

ProductBookingCredit_AppliesToCharges · boolean

Filter by whether this universal credit applies to other charges.

Range Filters

from_ProductBookingCredit_Credit · number

Filter by credit amount greater than or equal to this value.

to_ProductBookingCredit_Credit · number

Filter by credit amount less than or equal to this value.

from_ProductBookingCredit_ExpireTimeInMonths · integer

Filter by the expire time in months value for this product booking credit greater than or equal to this value.

to_ProductBookingCredit_ExpireTimeInMonths · integer

Filter by the expire time in months value for this product booking credit less than or equal to this value.

from_ProductBookingCredit_ExpireTimeInWeeks · integer

Filter by the expire time in weeks value for this product booking credit greater than or equal to this value.

to_ProductBookingCredit_ExpireTimeInWeeks · integer

Filter by the expire time in weeks value for this product booking credit less than or equal to this value.

from_ProductBookingCredit_ExpiresIn · integer

Filter by number of periods (of ExpirationType) until the released credit expires greater than or equal to this value.

to_ProductBookingCredit_ExpiresIn · integer

Filter by number of periods (of ExpirationType) until the released credit expires less than or equal to this value.

from_ProductBookingCredit_CreatedOn · string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

to_ProductBookingCredit_CreatedOn · string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

from_ProductBookingCredit_UpdatedOn · string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

to_ProductBookingCredit_UpdatedOn · string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/billing/productbookingcredits?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by Name

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/billing/productbookingcredits?ProductBookingCredit_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/billing/productbookingcredits?from_ProductBookingCredit_UpdatedOn=2025-01-01T00:00&to_ProductBookingCredit_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Records · ProductBookingCredit[]

The list of ProductBookingCredit records matching the query. See the Get one ProductBookingCredit endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each ProductBookingCredit. The following fields are not populated in the Records[] response: ExpireTimeInMonths, ExpireTimeInWeeks, CaneBeUsedForBookings, CaneBeUsedForEvents, ExpiresIn, IsUniversalCredit, AppliesToCharges.

To get all fields, fetch the full record using the Get one ProductBookingCredit endpoint.

Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

CurrentPage · integer

Current page number.

CurrentPageSize · integer

Number of records per page.

CurrentOrderField · string

The field used for sorting.

CurrentSortDirection · integer

The sort direction (0 = ascending, 1 = descending).

FirstItem · integer

Index of the first item on the current page.

LastItem · integer

Index of the last item on the current page.

TotalItems · integer

Total number of matching records across all pages.

TotalPages · integer

Total number of pages.

HasNextPage · boolean

Whether there is a next page of results.

HasPreviousPage · boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "Name": "",
      "ProductId": 0,
      "ProductName": null,
      "ProductBusinessCurrencyCode": null,
      "ElegibleResourceTypes": [],
      "ElegibleProducts": [],
      "ElegibleTariffs": [],
      "Credit": 0,
      "EventCategories": [],
      "ExpirationType": 0,
      "ElegiblePasses": [],
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "[e-mail]",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "ProductBookingCredit Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}