Get one TariffBookingCredit

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>'

import requests

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

{
  "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>"
}

Plan booking credit (internally TariffBookingCredit) represents an amount of monetary credit linked to a plan (internally Tariff). The Credit value specifies how much credit is included. The renewal time controls how often the credit expires and the allowance resets.

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

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"

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

string

Credit name.

integer

ID of the plan linked to this record.

string

Display value for Tariff.Name..

string

Display value for Tariff.Business.Currency.Code..

integer[]

List of the IDs of the resource types this booking credit can be used for.

integer[]

List of the IDs of the products this booking credit can be used for. Applies only when IsUniversalCredit is true..

integer[]

List of the IDs of the plans this booking credit can be used for. Applies only when IsUniversalCredit is true..

number

Credit amount.

boolean

Whether this credit can be used to pay for bookings. Restrict to specific resource types using elegible-resource-types.

boolean

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

integer[]

List of the IDs of the event categories this booking credit can be used for. Applies only when IsUniversalCredit is true..

integer

How often will this credit amount will expire and be issued again. Most common option is TariffMonth, which follows the plan renewal cycle.. See eTimeSpanWeekMonth enum values: 1 = Week, 2 = CalendarMonth, 3 = TariffMonth, 4 = Year, 5 = Day.

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 the IDs of the passes this booking credit can be used for. Applies only when IsUniversalCredit is true..

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

{
  "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
}

Get one TariffBookingCredit

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

import requests

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

{
  "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>"
}

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