Skip to main content
GET
/
api
/
billing
/
contractschedules
/
{id}
Get one ContractSchedule
curl --request GET \
  --url https://spaces.nexudus.com/api/billing/contractschedules/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "CoworkerContractId": 123,
  "CoworkerContractQuantity": 123,
  "CoworkerContractFloorPlanDeskIds": "<string>",
  "CoworkerContractFloorPlanDeskNames": "<string>",
  "CoworkerContractTariffName": "<string>",
  "CoworkerContractCoworkerId": 123,
  "CoworkerContractCoworkerFullName": "<string>",
  "CoworkerContractCoworkerBillingName": "<string>",
  "Notes": "<string>",
  "Price": 123,
  "ApplyOn": "<string>",
  "ApplyOnLocal": "<string>",
  "Applied": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A ContractSchedule defines a future price change for a plan contract (CoworkerContract). On the date specified by ApplyOn, the system automatically updates the contract’s price to the value in Price. Schedules allow operators to pre-configure stepped pricing — for example, an introductory rate for the first few months that transitions to a full rate on a known date — without any manual intervention at the time of the change. Once a schedule has been processed, Applied is set to true and the record becomes read-only.

​
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 ContractSchedule-Read role.

​
Path Parameters

​
id
integer
required
The Id of the ContractSchedule record to retrieve.

​
Code Examples

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

​
Response

​
200

​
CoworkerContractId
integer
ID of the coworker contract linked to this record.
​
CoworkerContractQuantity
integer
The coworker contract quantity value for this contract schedule.
​
CoworkerContractFloorPlanDeskIds
string
The coworker contract floor plan desk ids value for this contract schedule.
​
CoworkerContractFloorPlanDeskNames
string
The coworker contract floor plan desk names value for this contract schedule.
​
CoworkerContractTariffName
string
Name of the tariff/plan associated with the parent contract.
​
CoworkerContractCoworkerId
integer
ID of the coworker contract coworker associated with this record.
​
CoworkerContractCoworkerFullName
string
Full name of the member holding the parent contract.
​
CoworkerContractCoworkerBillingName
string
Billing name of the member holding the parent contract.
​
Notes
string
Optional notes or internal comments about this scheduled price change.
​
Price
number
The new contract price to apply on the scheduled date.
​
ApplyOn
string
Date on which the system will automatically update the contract price to the value in Price.
​
ApplyOnLocal
string
Date/time value for apply on local.
​
Applied
boolean
True once the price change has been applied to the contract. The record becomes read-only after this point.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "CoworkerContractId": 0,
  "CoworkerContractQuantity": null,
  "CoworkerContractFloorPlanDeskIds": null,
  "CoworkerContractFloorPlanDeskNames": null,
  "CoworkerContractTariffName": null,
  "CoworkerContractCoworkerId": null,
  "CoworkerContractCoworkerFullName": null,
  "CoworkerContractCoworkerBillingName": null,
  "Notes": null,
  "Price": null,
  "ApplyOn": "2025-01-15T10:30:00Z",
  "ApplyOnLocal": null,
  "Applied": false,
  "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": "ContractSchedule Example",
  "LocalizationDetails": null,
  "CustomFields": null
}