Skip to main content
PUT
/
api
/
billing
/
coworkerextraservices
Update CoworkerExtraService
curl --request PUT \
  --url https://spaces.nexudus.com/api/billing/coworkerextraservices \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "CoworkerId": 123,
  "BusinessId": 123,
  "ExtraServiceId": 123,
  "TotalUses": 123,
  "ChargePeriod": 123
}
'
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt

Use this file to discover all available pages before exploring further.

Updates an existing CoworkerExtraService record. You must include the Id of the record to update along with all required fields.

​
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-Edit role.

​
Request Body

​
Required Fields

​
Id
integer
required
The Id of the CoworkerExtraService record to update.
​
CoworkerId
integer
required
Coworker Id.
​
BusinessId
integer
required
Business Id.
​
ExtraServiceId
integer
required
Extra Service Id.
​
TotalUses
integer
required
Total credit originally allocated (time or printing). Unit depends on the ChargePeriod of the linked extra service.
​
ChargePeriod
integer
required
Unit of measurement for time credit (Minutes, Days, Weeks, Months, Uses, FourWeekMonths).

​
Optional Fields

​
Notes
string
Internal notes.
​
Free
boolean
Whether this charge or credit is free (no cost to the customer).
​
Price
number
Price charged for this extra service.
​
ValidFrom
string
Date from which this credit becomes usable.
​
ExpireDate
string
Date when this credit expires and can no longer be used.
​
DueDate
string
Payment due date for the charge.
​
PurchaseOrder
string
Purchase order.
​
InvoiceThisCoworker
boolean
Invoice the customer directly instead of the team or company paying member.
​
BookingId
integer
ID of the booking that generated this charge.
​
BookingFromTime
string
Start time of the booking that generated this charge.
​
BookingToTime
string
End time of the booking that generated this charge.
​
BookingResourceName
string
Name of the resource booked (e.g., meeting room name).
​
CoworkerContractUniqueId
string
Links this credit back to the customer contract that provisioned it.

​
Code Examples

curl -X PUT \
  "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,
    "Id": 87654321
}'

​
Response

​
200

​
Status
integer
HTTP status code. 200 on success.
​
Message
string
A human-readable message confirming the update.
​
Value
object
Contains the Id of the updated record.
​
WasSuccessful
boolean
true if the coworkerextraservice was updated successfully.
​
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "CoworkerExtraService was successfully updated.",
  "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

​
Message
string
A summary of the validation error(s), in the format PropertyName: error message.
​
Value
any
null on validation failure.
​
Errors
object[]
Array of validation errors.
​
WasSuccessful
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
}