Skip to main content
GET
/
api
/
billing
/
coworkerbookingcredits
/
{id}
{
  "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

​
id
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"

​
Response

​
200

​
CoworkerId
integer
ID of the customer this credit is assigned to.
​
BusinessId
integer
ID of the location issuing the credit.
​
BusinessName
string
Location name.
​
BusinessCurrencyCode
string
Currency code of the location.
​
Description
string
Optional description or label for this credit.
​
TariffBookingCreditId
integer
ID of the plan credit template (TariffBookingCredit) that originated this credit, if any.
​
TariffBookingCreditName
string
Name of the plan credit template that originated this credit.
​
ElegibleResourceTypes
integer[]
Resource types this credit can be used for. If empty, the credit is valid for all resource types.
​
ElegibleProducts
integer[]
Products this credit can be used for. If empty, applies to all products.
​
ElegibleTariffs
integer[]
Plans (tariffs) this credit is restricted to. If empty, applies to customers on any plan.
​
RemainingCredit
number
Remaining credit balance.
​
TotalCredit
number
Total credit amount originally assigned.
​
ValidFrom
string
Date from which this credit is valid.
​
ExpireDate
string
Date on which this credit expires.
​
CaneBeUsedForBookings
boolean
Whether this credit can be used to pay for bookings. Restrict to specific resource types with ElegibleResourceTypes.
​
CaneBeUsedForEvents
boolean
Whether this credit can be used to pay for event sign-ups. Restrict to specific categories with EventCategories.
​
EventCategories
integer[]
Event categories this credit can be used for. If empty, applies to all event categories.
​
IsUniversalCredit
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.
​
CoworkerProductUniqueId
string
Unique ID of the product purchase that created this credit.
​
UseCreditPrice
boolean
Whether to use the credit price instead of the standard booking price when this credit is applied.
​
CoworkerContractUniqueId
string
Unique ID of the contract that originated this credit.
​
ElegiblePasses
integer[]
Time passes this credit can be used for. If empty, applies to all passes.
​
AppliesToCharges
boolean
Whether this universal credit applies to other charges.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
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
}