Get one ProductExtraService

GET

api

billing

productextraservices

{id}

Get one ProductExtraService

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

import requests

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

{
  "ProductId": 123,
  "ProductName": "<string>",
  "ExtraServiceId": 123,
  "ExtraServiceName": "<string>",
  "ExtraServiceChargePeriod": "<string>",
  "ExtraServiceIsBookingCredit": true,
  "ExtraServiceIsPrintingCredit": true,
  "UsesIncluded": 123,
  "ExpireTimeInMonths": 123,
  "ExpireTimeInWeeks": 123,
  "ExpirationType": 123,
  "ExpiresIn": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A ProductExtraService links an ExtraService to a Product. The meaning of UsesIncluded depends on the type of the linked extra service:

Booking time (ExtraService with IsPrintingCredit = false) — customers receive an allowance of booking time for the resource type(s) associated with that extra service. For example, a product called “Hot Desk Bundle” might include 2 hours of meeting room usage — achieved by linking a “Meeting Room Hourly” extra service with “UsesIncluded 120.
Printing credit (ExtraService with IsPrintingCredit = true) — customers receive a number of print jobs/pages. UsesIncluded is the number of printing credits included. The linked extra service must have ChargePeriod = 5 (Uses) and Price = 1.

Always check IsPrintingCredit on the linked extra service before interpreting UsesIncluded. For booking-time extra services, the unit of UsesIncluded is determined by the ChargePeriod of the linked ExtraService:

ExtraService ChargePeriod	UsesIncluded unit
1 (Minutes)	Minutes
2 (Days)	Days
3 (Weeks)	Weeks
4 (Months)	Months
5 (Uses)	Individual uses
6 (FourWeekMonths)	4-week periods

So “UsesIncluded 60 on a minutes extra service means 60 minutes of booking time included. On a daily extra service it means 60 full days.

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

Path Parameters

integer

required

The Id of the ProductExtraService record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the product linked to this record.

string

Product name.

integer

ID of the extra service linked to this record.

string

Extra service name.

string

Charge period of the linked extra service.

boolean

Benefit is booking credit.

boolean

Benefit is printing credit.

integer

Uses included.

integer

The expire time in months value for this product extra service.

integer

The expire time in weeks value for this product extra service.

integer

Expiration type.

integer

Expires in.

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

{
  "ProductId": 0,
  "ProductName": null,
  "ExtraServiceId": 0,
  "ExtraServiceName": null,
  "ExtraServiceChargePeriod": null,
  "ExtraServiceIsBookingCredit": false,
  "ExtraServiceIsPrintingCredit": false,
  "UsesIncluded": 0,
  "ExpireTimeInMonths": null,
  "ExpireTimeInWeeks": null,
  "ExpirationType": 0,
  "ExpiresIn": null,
  "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": "ProductExtraService Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple ProductExtraServicesRetrieve multiple ProductExtraService records by their Ids in a single request.

Get one ProductExtraService

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

import requests

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

{
  "ProductId": 123,
  "ProductName": "<string>",
  "ExtraServiceId": 123,
  "ExtraServiceName": "<string>",
  "ExtraServiceChargePeriod": "<string>",
  "ExtraServiceIsBookingCredit": true,
  "ExtraServiceIsPrintingCredit": true,
  "UsesIncluded": 123,
  "ExpireTimeInMonths": 123,
  "ExpireTimeInWeeks": 123,
  "ExpirationType": 123,
  "ExpiresIn": 123,
  "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