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,
  "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 CoworkerBookingCredit is an amount of monetary credit assigned to a customer. Credits are typically created automatically when a customer’s contract on a plan that includes a TariffBookingCredit renews, but can also be created manually. 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 ValidFrom and ExpireDate to control the validity window of the credit.

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 credit is assigned to.

integer

ID of the location issuing the credit.

string

Location name.

string

Currency code of the location.

string

Optional description or label for this credit.

integer

ID of the plan credit template (TariffBookingCredit) that originated this credit, if any.

string

Name of the plan credit template that originated this credit.

integer[]

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

integer[]

Products this credit can be used for. If empty, applies to all products.

integer[]

Plans (tariffs) this credit is restricted to. If empty, applies to customers on any plan.

number

Remaining credit balance.

number

Total credit amount originally assigned.

string

Date from which this credit is valid.

string

Date on which this credit expires.

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[]

Event categories this credit can be used for. If empty, applies to all event categories.

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.

string

Unique ID of the product purchase that created this credit.

boolean

Whether to use the credit price instead of the standard booking price when this credit is applied.

string

Unique ID of the contract that originated this credit.

integer[]

Time passes this credit can be used for. If empty, applies to all passes.

boolean

Whether this universal credit applies to other charges.

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,
  "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 multiple CoworkerBookingCreditsRetrieve multiple CoworkerBookingCredit records by their Ids in a single request.

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,
  "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