CoworkerExtraServices
Get one CoworkerExtraService
Retrieve a single CoworkerExtraService record by its Id.
GET
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
BookingIdand 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
ChargePeriodof the linked extra service (minutes, days, uses, etc.).TotalUsesandRemainingUsestrack the allowance. - Printing credit — credits for printing integrations such as PaperCut or Ezeep. The linked extra service has
IsPrintingCredit = true.TotalUsesandRemainingUsestrack the number of print jobs or pages available.
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
The Id of the CoworkerExtraService record to retrieve.
Code Examples
Response
200
Coworker Id.
Business Id.
Extra Service Id.
Name of the linked extra service.
Currency code of the linked extra service (e.g., USD, EUR).
True if the linked extra service is a printing credit (PaperCut/Ezeep). False for booking time credit.
Free-text description of this charge or credit.
Internal notes.
Remaining credit (time or printing) the customer can still use.
Total credit originally allocated (time or printing). Unit depends on the ChargePeriod of the linked extra service.
Whether this charge or credit is free (no cost to the customer).
Price charged for this extra service.
Price adjustment applied for last-minute bookings.
Price adjustment applied by demand-based dynamic pricing.
Multiplier applied for last-minute booking pricing.
Multiplier applied for demand-based pricing.
Date from which this credit becomes usable.
Date when this credit expires and can no longer be used.
Payment due date for the charge.
Purchase order.
Unit of measurement for time credit (Minutes, Days, Weeks, Months, Uses, FourWeekMonths).
Whether this charge has already been invoiced.
Invoice date.
Whether this credit was automatically provisioned from the customer’s plan (tariff).
Links this credit back to the time pass definition in the plan.
Links this credit back to the customer product that provisioned it.
Unique ID of the booking that generated this charge.
Whether this record was automatically created (e.g., from a booking or plan renewal).
Invoice the customer directly instead of the team or company paying member.
Discount code.
Unique ID of the discount applied to this charge.
Amount discounted from the price.
ID of the booking that generated this charge.
Start time of the booking that generated this charge.
End time of the booking that generated this charge.
Name of the resource booked (e.g., meeting room name).
Links this credit back to the customer contract that provisioned it.
Unique record identifier.
UUID of the record.
Date and time the record was created (ISO 8601).
Date and time the record was last updated (ISO 8601).
Email of the user who last updated this record.
Whether the record was recently created.
External system identifier.
Example Response