Search ProductBookingCredits

GET

api

billing

productbookingcredits

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

import requests

url = "https://spaces.nexudus.com/api/billing/productbookingcredits"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/billing/productbookingcredits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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. When is the credit released?

Admin sale (via CoworkerProduct): An admin can choose to release the credit before payment by setting ActivateNow = true when selling the product.
Member purchase (online, active contract): Credits are released immediately unless the Store.AlwaysInvoice business setting is enabled, in which case credits release after payment.
Contact purchase (online, no active contract): Credits are released after the product is paid.

Credit can be configured for bookings (with CaneBeUsedForBookings and ElegibleResourceTypes), events (with CaneBeUsedForEvents and EventCategories), or as a universal credit (with IsUniversalCredit) applicable to products, time passes, and other 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

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

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

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

string

Filter by credit name.

integer

Filter by iD of the product linked to this record.

string

Filter by display value for Product.Name..

string

Filter by display value for Product.Business.Currency.Code..

number

Filter by credit amount that will be released to the customer’s account as a CoworkerBookingCredit. Release timing depends on purchase method: admin sales can release before payment (ActivateNow), member purchases release immediately (unless Store.AlwaysInvoice is set), and contact purchases release after payment.

integer

Filter by expiration period in months (legacy field, use ExpiresIn with ExpirationType instead).

integer

Filter by expiration period in weeks (legacy field, use ExpiresIn with ExpirationType instead).

boolean

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

boolean

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

integer

Filter by expiration type: PricePlan (expires at end of billing period of the main contract - customer must have a main contract), Day, Week, Month, Year, or LastDayOfMonth.

integer

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

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.

boolean

Filter by whether this universal credit applies to other charges beyond products and passes.

Range Filters

number

integer

Filter by expiration period in months (legacy field, use ExpiresIn with ExpirationType instead) greater than or equal to this value.

integer

Filter by expiration period in months (legacy field, use ExpiresIn with ExpirationType instead) less than or equal to this value.

integer

Filter by expiration period in weeks (legacy field, use ExpiresIn with ExpirationType instead) greater than or equal to this value.

integer

Filter by expiration period in weeks (legacy field, use ExpiresIn with ExpirationType instead) less than or equal to this value.

integer

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

integer

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

string

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

string

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

string

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

string

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

Code Examples

Simple listing

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

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/productbookingcredits?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Name',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/productbookingcredits',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by Name

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

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/productbookingcredits?' + new URLSearchParams({
    ProductBookingCredit_Name: 'example-value',
    orderBy: 'Name',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/productbookingcredits',
    params={
        'ProductBookingCredit_Name': 'example-value',
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/productbookingcredits?' + new URLSearchParams({
    from_ProductBookingCredit_UpdatedOn: '2025-01-01T00:00',
    to_ProductBookingCredit_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/productbookingcredits',
    params={
        'from_ProductBookingCredit_UpdatedOn': '2025-01-01T00:00',
        'to_ProductBookingCredit_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

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.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.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

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

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "Name": "",
      "ProductId": 0,
      "ProductName": null,
      "ProductBusinessCurrencyCode": null,
      "ElegibleResourceTypes": [],
      "ElegibleProducts": [],
      "ElegibleTariffs": [],
      "Credit": 0,
      "CaneBeUsedForBookings": false,
      "CaneBeUsedForEvents": false,
      "EventCategories": [],
      "ExpirationType": 0,
      "ExpiresIn": null,
      "IsUniversalCredit": false,
      "ElegiblePasses": [],
      "AppliesToCharges": false,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "admin@example.com",
      "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
}

Search ProductBookingCredits

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

import requests

url = "https://spaces.nexudus.com/api/billing/productbookingcredits"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/billing/productbookingcredits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200