Get one ProductBookingCredit

GET

api

billing

productbookingcredits

{id}

Get one ProductBookingCredit

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

import requests

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

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/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Name": "<string>",
  "ProductId": 123,
  "ProductName": "<string>",
  "ProductBusinessCurrencyCode": "<string>",
  "ElegibleResourceTypes": [
    123
  ],
  "ElegibleProducts": [
    123
  ],
  "ElegibleTariffs": [
    123
  ],
  "Credit": 123,
  "ExpireTimeInMonths": 123,
  "ExpireTimeInWeeks": 123,
  "CaneBeUsedForBookings": true,
  "CaneBeUsedForEvents": true,
  "EventCategories": [
    123
  ],
  "ExpirationType": 123,
  "ExpiresIn": 123,
  "IsUniversalCredit": true,
  "ElegiblePasses": [
    123
  ],
  "AppliesToCharges": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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

Path Parameters

integer

required

The Id of the ProductBookingCredit record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/billing/productbookingcredits/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/productbookingcredits/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/productbookingcredits/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

string

Credit name.

integer

ID of the product linked to this record.

string

Display value for Product.Name..

string

Display value for Product.Business.Currency.Code..

integer[]

List of eligible resource types this credit can be used for. If empty, the credit is valid for all resource types.

integer[]

List of eligible products this universal credit can be used to purchase. If empty and IsUniversalCredit is true, the credit applies to all products.

integer[]

List of eligible tariffs (plans) this credit is valid for.

number

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

Expiration period in months (legacy field, use ExpiresIn with ExpirationType instead).

integer

Expiration period in weeks (legacy field, use ExpiresIn with ExpirationType instead).

boolean

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

boolean

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

integer[]

List of event categories this credit is valid for. If empty and CaneBeUsedForEvents is true, the credit is valid for all events.

integer

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

Number of periods (of ExpirationType) until the released credit expires.

boolean

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.

integer[]

List of eligible time passes this universal credit can be used to purchase. If empty and IsUniversalCredit is true, the credit applies to all passes.

boolean

Whether this universal credit applies to other charges beyond products and passes.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "Name": "",
  "ProductId": 0,
  "ProductName": null,
  "ProductBusinessCurrencyCode": null,
  "ElegibleResourceTypes": [],
  "ElegibleProducts": [],
  "ElegibleTariffs": [],
  "Credit": 0,
  "ExpireTimeInMonths": null,
  "ExpireTimeInWeeks": null,
  "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
}

Get one ProductBookingCredit

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

import requests

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

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/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Name": "<string>",
  "ProductId": 123,
  "ProductName": "<string>",
  "ProductBusinessCurrencyCode": "<string>",
  "ElegibleResourceTypes": [
    123
  ],
  "ElegibleProducts": [
    123
  ],
  "ElegibleTariffs": [
    123
  ],
  "Credit": 123,
  "ExpireTimeInMonths": 123,
  "ExpireTimeInWeeks": 123,
  "CaneBeUsedForBookings": true,
  "CaneBeUsedForEvents": true,
  "EventCategories": [
    123
  ],
  "ExpirationType": 123,
  "ExpiresIn": 123,
  "IsUniversalCredit": true,
  "ElegiblePasses": [
    123
  ],
  "AppliesToCharges": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200