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 = Uses and Price = 1.

Unit of UsesIncluded: The unit is determined by the ChargePeriod of the linked ExtraService:

Minutes (1): UsesIncluded is in minutes
Days (2): UsesIncluded is in days
Weeks (3): UsesIncluded is in weeks
Months (4): UsesIncluded is in months
Uses (5): UsesIncluded is in individual uses (e.g., print credits)
FourWeekMonths (6): UsesIncluded is in 4-week periods

When is the credit released? The credit is released as a CoworkerBookingCredit on the customer’s account when the product is purchased:

Admin sale (via CoworkerProduct): An admin can choose to release the credit before payment by setting ActivateNow = true when selling the product.
Member purchase (online, active contract): Credits are released immediately unless the Store.AlwaysInvoice business setting is enabled, in which case credits release after payment.
Contact purchase (online, no active contract): Credits are released after the product is paid.

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

Display value for Product.Name..

integer

ID of the extra service linked to this record. Check IsPrintingCredit to determine if UsesIncluded represents booking time or printing credits. Check ChargePeriod to determine the unit of UsesIncluded (Minutes, Days, Weeks, Months, Uses, or FourWeekMonths).

string

Display value for ExtraService.Name..

string

Display value for ExtraService.ChargePeriod..

boolean

Display value for ExtraService.IsBookingCredit..

boolean

Display value for ExtraService.IsPrintingCredit..

integer

Number of uses included. The unit depends on the ChargePeriod of the linked ExtraService: Minutes (1) = minutes of booking time, Days (2) = days, Weeks (3) = weeks, Months (4) = months, Uses (5) = individual uses (e.g., print credits), FourWeekMonths (6) = 4-week periods. For printing credits, the extra service should have ChargePeriod = Uses (5)..

integer

Expiration period in months (legacy field, use ExpiresIn with ExpirationType instead).

integer

Expiration period in weeks (legacy field, use ExpiresIn with ExpirationType instead).

integer

Expiration type: PricePlan (expires at end of billing period of the main contract - customer must have a main contract), Day, Week, Month, Year, or LastDayOfMonth.

integer

Number of periods (of ExpirationType) until the released credit expires.

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": null,
  "ExtraServiceIsPrintingCredit": null,
  "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 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