Get one CoworkerBookingCredit

GET

api

billing

coworkerbookingcredits

{id}

Get one CoworkerBookingCredit

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

import requests

url = "https://spaces.nexudus.com/api/billing/coworkerbookingcredits/{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/coworkerbookingcredits/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "BusinessId": 123,
  "BusinessName": "<string>",
  "BusinessCurrencyCode": "<string>",
  "Description": "<string>",
  "TariffBookingCreditId": 123,
  "TariffBookingCreditName": "<string>",
  "ElegibleResourceTypes": [
    123
  ],
  "ElegibleProducts": [
    123
  ],
  "ElegibleTariffs": [
    123
  ],
  "RemainingCredit": 123,
  "TotalCredit": 123,
  "ValidFrom": "<string>",
  "ExpireDate": "<string>",
  "CaneBeUsedForBookings": true,
  "CaneBeUsedForEvents": true,
  "EventCategories": [
    123
  ],
  "IsUniversalCredit": true,
  "CoworkerProductUniqueId": "<string>",
  "UseCreditPrice": true,
  "CoworkerContractUniqueId": "<string>",
  "ElegiblePasses": [
    123
  ],
  "AppliesToCharges": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A booking credit (internally CoworkerBookingCredit) is a monetary balance assigned to a customer that can pay for bookings, event sign-ups, or, when universal credit is enabled, products, plans, passes, and selected one-off charges. It can be created manually or released from a plan or product benefit, and its availability can be limited by eligibility and a validity period.

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

Path Parameters

integer

required

The Id of the CoworkerBookingCredit record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the customer this booking credit belongs to.

string

Display value for Coworker.FullName..

integer

ID of the location that issued and owns this booking credit.

string

Display value for Business.Name..

string

Display value for Business.Currency.Code..

string

Optional operator-facing label or description for this booking credit.

integer

Read-only ID of the plan booking-credit definition that created this credit, if applicable.

string

Display value for TariffBookingCredit.Name..

integer[]

List of resource-type IDs this credit can pay for when CaneBeUsedForBookings is true; an empty list allows every resource type.

integer[]

List of product IDs this universal credit can pay for; when IsUniversalCredit is true, an empty list allows every product.

integer[]

List of plan IDs this universal credit can pay for; when IsUniversalCredit is true, an empty list allows every plan.

number

Read-only monetary amount still available; the system initializes it from TotalCredit and changes it through credit use or an adjustment.

number

Total monetary amount assigned when this credit is created; it sets the initial RemainingCredit.

string

Optional UTC date and time when this credit becomes usable; blank means it is usable immediately.

string

Optional UTC date and time when this credit stops being usable; blank means no expiry, and when set it must be later than ValidFrom.

boolean

Whether this credit can pay for bookings; use ElegibleResourceTypes to limit eligible resource types.

boolean

Whether this credit can pay for event sign-ups; use EventCategories to limit eligible event categories.

integer[]

List of event-category IDs this credit can pay for when CaneBeUsedForEvents is true; an empty list allows every event category.

boolean

Whether this credit can pay for products, plans, passes, and eligible charges; use the eligibility lists and AppliesToCharges to restrict those uses.

string

Internal unique ID linking this credit to the product purchase that created it.

boolean

System-calculated flag indicating whether any eligible resource type has a booking rate with a credit price.

string

Internal unique ID linking this credit to the contract that originated it.

integer[]

List of pass IDs this universal credit can pay for; when IsUniversalCredit is true, an empty list allows every pass.

boolean

Whether this universal credit can pay for one-off charges in addition to products, plans, 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

{
  "CoworkerId": 0,
  "CoworkerFullName": null,
  "BusinessId": 0,
  "BusinessName": null,
  "BusinessCurrencyCode": null,
  "Description": null,
  "TariffBookingCreditId": null,
  "TariffBookingCreditName": null,
  "ElegibleResourceTypes": [],
  "ElegibleProducts": [],
  "ElegibleTariffs": [],
  "RemainingCredit": 0,
  "TotalCredit": 0,
  "ValidFrom": null,
  "ExpireDate": null,
  "CaneBeUsedForBookings": false,
  "CaneBeUsedForEvents": false,
  "EventCategories": [],
  "IsUniversalCredit": false,
  "CoworkerProductUniqueId": null,
  "UseCreditPrice": false,
  "CoworkerContractUniqueId": null,
  "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": "CoworkerBookingCredit Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one CoworkerBookingCredit

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

import requests

url = "https://spaces.nexudus.com/api/billing/coworkerbookingcredits/{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/coworkerbookingcredits/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "BusinessId": 123,
  "BusinessName": "<string>",
  "BusinessCurrencyCode": "<string>",
  "Description": "<string>",
  "TariffBookingCreditId": 123,
  "TariffBookingCreditName": "<string>",
  "ElegibleResourceTypes": [
    123
  ],
  "ElegibleProducts": [
    123
  ],
  "ElegibleTariffs": [
    123
  ],
  "RemainingCredit": 123,
  "TotalCredit": 123,
  "ValidFrom": "<string>",
  "ExpireDate": "<string>",
  "CaneBeUsedForBookings": true,
  "CaneBeUsedForEvents": true,
  "EventCategories": [
    123
  ],
  "IsUniversalCredit": true,
  "CoworkerProductUniqueId": "<string>",
  "UseCreditPrice": true,
  "CoworkerContractUniqueId": "<string>",
  "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

Get one CoworkerBookingCredit

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200