Create CoworkerExtraService

POST

api

billing

coworkerextraservices

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/coworkerextraservices \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CoworkerId": 123,
  "BusinessId": 123,
  "ExtraServiceId": 123,
  "TotalUses": 123,
  "ChargePeriod": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/billing/coworkerextraservices"

payload = {
    "CoworkerId": 123,
    "BusinessId": 123,
    "ExtraServiceId": 123,
    "TotalUses": 123,
    "ChargePeriod": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    CoworkerId: 123,
    BusinessId: 123,
    ExtraServiceId: 123,
    TotalUses: 123,
    ChargePeriod: 123
  })
};

fetch('https://spaces.nexudus.com/api/billing/coworkerextraservices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<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-Create role.

Enums

eChargePeriod — ChargePeriod values

Value	Name
1	Minutes
2	Days
3	Weeks
4	Months
5	Uses
6	FourWeekMonths

Request Body

Required Fields

integer

required

ID of the coworker linked to this record.

integer

required

ID of the business linked to this record.

integer

required

ID of the extra service linked to this record.

integer

required

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

integer

required

Unit of measurement for time credit (Minutes, Days, Weeks, Months, Uses, FourWeekMonths). Defaults to eChargePeriod.Minutes.

Optional Fields

string

Internal notes.

boolean

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

number

Price charged for this extra service.

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.

boolean

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

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.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/billing/coworkerextraservices" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CoworkerId": 0,
    "BusinessId": 0,
    "ExtraServiceId": 0,
    "TotalUses": 0,
    "ChargePeriod": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerextraservices',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      CoworkerId: 0,
      BusinessId: 0,
      ExtraServiceId: 0,
      TotalUses: 0,
      ChargePeriod: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/billing/coworkerextraservices',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'CoworkerId': 0,
        'BusinessId': 0,
        'ExtraServiceId': 0,
        'TotalUses': 0,
        'ChargePeriod': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the coworkerextraservice was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CoworkerExtraService was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "ChargePeriod: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "ChargePeriod"
    }
  ],
  "WasSuccessful": false
}

Update CoworkerExtraServiceUpdate an existing CoworkerExtraService record.

Create CoworkerExtraService

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/coworkerextraservices \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CoworkerId": 123,
  "BusinessId": 123,
  "ExtraServiceId": 123,
  "TotalUses": 123,
  "ChargePeriod": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/billing/coworkerextraservices"

payload = {
    "CoworkerId": 123,
    "BusinessId": 123,
    "ExtraServiceId": 123,
    "TotalUses": 123,
    "ChargePeriod": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    CoworkerId: 123,
    BusinessId: 123,
    ExtraServiceId: 123,
    TotalUses: 123,
    ChargePeriod: 123
  })
};

fetch('https://spaces.nexudus.com/api/billing/coworkerextraservices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400