Skip to main content
GET
/
api
/
billing
/
tariffbookingcredits
/
{id}
Get one TariffBookingCredit
curl --request GET \
  --url https://spaces.nexudus.com/api/billing/tariffbookingcredits/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "Name": "<string>",
  "TariffId": 123,
  "TariffName": "<string>",
  "TariffBusinessCurrencyCode": "<string>",
  "ElegibleResourceTypes": [
    123
  ],
  "ElegibleProducts": [
    123
  ],
  "ElegibleTariffs": [
    123
  ],
  "Credit": 123,
  "CaneBeUsedForBookings": true,
  "CaneBeUsedForEvents": true,
  "EventCategories": [
    123
  ],
  "ServiceRenewalTime": 123,
  "IsUniversalCredit": true,
  "ElegiblePasses": [
    123
  ],
  "AppliesToCharges": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A TariffBookingCredit represents an amount of credit linked to a plan (Tariff). When a customer’s contract on that plan renews, the credit is automatically released as a CoworkerBookingCredit on the customer’s account. 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 ServiceRenewalTime to control how often the credit is renewed (e.g. weekly, monthly).

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

​
Path Parameters

​
id
integer
required
The Id of the TariffBookingCredit record to retrieve.

​
Code Examples

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

​
Response

​
200

​
Name
string
Credit name.
​
TariffId
integer
ID of the tariff linked to this record.
​
TariffName
string
Tariff name.
​
TariffBusinessCurrencyCode
string
Tariff business currency code.
​
ElegibleResourceTypes
integer[]
List of elegible resource types linked to this record.
​
ElegibleProducts
integer[]
List of elegible products linked to this record.
​
ElegibleTariffs
integer[]
List of elegible tariffs linked to this record.
​
Credit
number
Credit amount.
​
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[]
List of event categories linked to this record.
​
ServiceRenewalTime
integer
Service renewal time period. See eTimeSpanWeekMonth enum values: 1 = Week, 2 = CalendarMonth, 3 = TariffMonth, 4 = Year, 5 = Day.
​
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.
​
ElegiblePasses
integer[]
List of elegible passes linked to this record.
​
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
{
  "Name": "",
  "TariffId": 0,
  "TariffName": null,
  "TariffBusinessCurrencyCode": null,
  "ElegibleResourceTypes": [],
  "ElegibleProducts": [],
  "ElegibleTariffs": [],
  "Credit": 0,
  "CaneBeUsedForBookings": false,
  "CaneBeUsedForEvents": false,
  "EventCategories": [],
  "ServiceRenewalTime": 0,
  "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": "TariffBookingCredit Example",
  "LocalizationDetails": null,
  "CustomFields": null
}