Get one CoworkerExtraService

GET

api

billing

coworkerextraservices

{id}

Get one CoworkerExtraService

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

import requests

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

{
  "CoworkerId": 123,
  "BusinessId": 123,
  "ExtraServiceId": 123,
  "ExtraServiceName": "<string>",
  "ExtraServiceCurrencyCode": "<string>",
  "ExtraServiceIsPrintingCredit": true,
  "Description": "<string>",
  "Notes": "<string>",
  "RemainingUses": 123,
  "TotalUses": 123,
  "Free": true,
  "Price": 123,
  "LastMinutePriceAdjustment": 123,
  "DynamicPriceAdjustment": 123,
  "PriceFactorLastMinute": 123,
  "PriceFactorDemand": 123,
  "ValidFrom": "<string>",
  "ExpireDate": "<string>",
  "DueDate": "<string>",
  "PurchaseOrder": "<string>",
  "ChargePeriod": 123,
  "Invoiced": true,
  "InvoiceDate": "<string>",
  "IsFromTariff": true,
  "TariffTimePassUniqueId": "<string>",
  "CoworkerProductUniqueId": "<string>",
  "BookingUniqueId": "<string>",
  "AutomaticallyAdded": true,
  "InvoiceThisCoworker": true,
  "DiscountCode": "<string>",
  "CoworkerDiscountUniqueId": "<string>",
  "DiscountAmount": 123,
  "BookingId": 123,
  "BookingFromTime": "<string>",
  "BookingToTime": "<string>",
  "BookingResourceName": "<string>",
  "CoworkerContractUniqueId": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A CoworkerExtraService records a charge or credit assigned to a customer. It covers three use cases:

Booking charges — charges associated with bookings (e.g., meeting room usage fees). These are linked to a specific booking via BookingId and track the resource, time range, and price.
Time credit — booking time allowances for specific resource types. Customers can spend these credits when booking resources of the matching type. The unit of credit depends on the ChargePeriod of the linked extra service (minutes, days, uses, etc.). TotalUses and RemainingUses track the allowance.
Printing credit — credits for printing integrations such as PaperCut or Ezeep. The linked extra service has IsPrintingCredit = true. TotalUses and RemainingUses track the number of print jobs or pages available.

Records can be created manually or added automatically from a plan (tariff). When IsFromTariff is true, the record was provisioned by a customer’s contract (CoworkerContract) and is linked via CoworkerContractUniqueId.

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

Path Parameters

integer

required

The Id of the CoworkerExtraService record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the coworker linked to this record.

integer

ID of the business linked to this record.

integer

ID of the extra service linked to this record.

string

Name of the linked extra service.

string

Currency code of the linked extra service (e.g., USD, EUR).

boolean

True if the linked extra service is a printing credit (PaperCut/Ezeep). False for booking time credit.

string

Free-text description of this charge or credit.

string

Internal notes.

integer

Remaining credit (time or printing) the customer can still use.

integer

Total credit originally allocated (time or printing). Unit depends on the ChargePeriod of the linked extra service.

boolean

Whether this charge or credit is free (no cost to the customer).

number

Price charged for this extra service.

number

Price adjustment applied for last-minute bookings.

number

Price adjustment applied by demand-based dynamic pricing.

number

Multiplier applied for last-minute booking pricing.

number

Multiplier applied for demand-based pricing.

string

Date from which this credit becomes usable.

string

Date when this credit expires and can no longer be used.

string

Payment due date for the charge.

string

Purchase order.

integer

Unit of measurement for time credit (Minutes, Days, Weeks, Months, Uses, FourWeekMonths). See eChargePeriod enum values: 1 = Minutes, 2 = Days, 3 = Weeks, 4 = Months, 5 = Uses, 6 = FourWeekMonths.

boolean

Whether this charge has already been invoiced.

string

Invoice date.

boolean

Whether this credit was automatically provisioned from the customer’s plan (tariff).

string

Links this credit back to the time pass definition in the plan.

string

Links this credit back to the customer product that provisioned it.

string

Unique ID of the booking that generated this charge.

boolean

Whether this record was automatically created (e.g., from a booking or plan renewal).

boolean

Invoice the customer directly instead of the team or company paying member.

string

Discount code.

string

Unique ID of the discount applied to this charge.

number

Amount discounted from the price.

integer

ID of the booking that generated this charge.

string

Start time of the booking that generated this charge.

string

End time of the booking that generated this charge.

string

Name of the resource booked (e.g., meeting room name).

string

Links this credit back to the customer contract that provisioned it.

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

{
  "CoworkerId": 0,
  "BusinessId": 0,
  "ExtraServiceId": 0,
  "ExtraServiceName": null,
  "ExtraServiceCurrencyCode": null,
  "ExtraServiceIsPrintingCredit": false,
  "Description": null,
  "Notes": null,
  "RemainingUses": 0,
  "TotalUses": 0,
  "Free": false,
  "Price": null,
  "LastMinutePriceAdjustment": null,
  "DynamicPriceAdjustment": null,
  "PriceFactorLastMinute": null,
  "PriceFactorDemand": null,
  "ValidFrom": null,
  "ExpireDate": null,
  "DueDate": null,
  "PurchaseOrder": null,
  "ChargePeriod": 0,
  "Invoiced": false,
  "InvoiceDate": null,
  "IsFromTariff": false,
  "TariffTimePassUniqueId": null,
  "CoworkerProductUniqueId": null,
  "BookingUniqueId": null,
  "AutomaticallyAdded": false,
  "InvoiceThisCoworker": false,
  "DiscountCode": null,
  "CoworkerDiscountUniqueId": null,
  "DiscountAmount": null,
  "BookingId": null,
  "BookingFromTime": null,
  "BookingToTime": null,
  "BookingResourceName": null,
  "CoworkerContractUniqueId": 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": "CoworkerExtraService Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple CoworkerExtraServicesRetrieve multiple CoworkerExtraService records by their Ids in a single request.

Get one CoworkerExtraService

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

import requests

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

{
  "CoworkerId": 123,
  "BusinessId": 123,
  "ExtraServiceId": 123,
  "ExtraServiceName": "<string>",
  "ExtraServiceCurrencyCode": "<string>",
  "ExtraServiceIsPrintingCredit": true,
  "Description": "<string>",
  "Notes": "<string>",
  "RemainingUses": 123,
  "TotalUses": 123,
  "Free": true,
  "Price": 123,
  "LastMinutePriceAdjustment": 123,
  "DynamicPriceAdjustment": 123,
  "PriceFactorLastMinute": 123,
  "PriceFactorDemand": 123,
  "ValidFrom": "<string>",
  "ExpireDate": "<string>",
  "DueDate": "<string>",
  "PurchaseOrder": "<string>",
  "ChargePeriod": 123,
  "Invoiced": true,
  "InvoiceDate": "<string>",
  "IsFromTariff": true,
  "TariffTimePassUniqueId": "<string>",
  "CoworkerProductUniqueId": "<string>",
  "BookingUniqueId": "<string>",
  "AutomaticallyAdded": true,
  "InvoiceThisCoworker": true,
  "DiscountCode": "<string>",
  "CoworkerDiscountUniqueId": "<string>",
  "DiscountAmount": 123,
  "BookingId": 123,
  "BookingFromTime": "<string>",
  "BookingToTime": "<string>",
  "BookingResourceName": "<string>",
  "CoworkerContractUniqueId": "<string>",
  "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