Skip to main content
GET
/
api
/
spaces
/
coworkerpriceplanhistories
/
{id}
{
  "CoworkerId": 123,
  "OldTariffName": "<string>",
  "NewTariffName": "<string>",
  "OldTariffUniqueId": "<string>",
  "NewTariffUniqueId": "<string>",
  "OldContractUniqueId": "<string>",
  "NewContractUniqueId": "<string>",
  "IsUpgrade": true,
  "Notes": "<string>",
  "OldValue": 123,
  "NewValue": 123,
  "OldQuantity": 123,
  "NewQuantity": 123,
  "CreatedOnLocal": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A CoworkerPricePlanHistory is an audit record of the different contracts (for different plans - Tariff entity) a customer has had. Each entry captures a plan change — recording the previous and new plan names, their values, and whether the change was an upgrade. This entity is read-only and is created automatically by the system whenever a customer’s plan changes.

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

​
Path Parameters

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

​
Code Examples

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

​
Response

​
200

​
CoworkerId
integer
Coworker Id.
​
OldTariffName
string
Name of the previous plan before the change.
​
NewTariffName
string
Name of the new plan after the change.
​
OldTariffUniqueId
string
Old Tariff Unique Id.
​
NewTariffUniqueId
string
New Tariff Unique Id.
​
OldContractUniqueId
string
Old Contract Unique Id.
​
NewContractUniqueId
string
New Contract Unique Id.
​
IsUpgrade
boolean
Whether the plan change was an upgrade (new plan value is higher).
​
Notes
string
Notes recorded at the time of the plan change.
​
OldValue
number
Price of the previous plan.
​
NewValue
number
Price of the new plan.
​
OldQuantity
integer
Quantity of the previous plan contract.
​
NewQuantity
integer
Quantity of the new plan contract.
​
CreatedOnLocal
string
Created On Local.
​
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
{
  "CoworkerId": 0,
  "OldTariffName": null,
  "NewTariffName": null,
  "OldTariffUniqueId": null,
  "NewTariffUniqueId": null,
  "OldContractUniqueId": null,
  "NewContractUniqueId": null,
  "IsUpgrade": false,
  "Notes": null,
  "OldValue": null,
  "NewValue": null,
  "OldQuantity": null,
  "NewQuantity": null,
  "CreatedOnLocal": 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": "CoworkerPricePlanHistory Example",
  "LocalizationDetails": null,
  "CustomFields": null
}