Get one ContractProduct

Retrieve a single ContractProduct record by its Id.

GET /api/billing/contractproducts/{id}

Get one ContractProduct

cURL

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/contractproducts/{id} \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "CoworkerContractId": 123,
  "CoworkerContractQuantity": 123,
  "CoworkerContractFloorPlanDeskIds": "<string>",
  "CoworkerContractFloorPlanDeskNames": "<string>",
  "CoworkerContractTariffName": "<string>",
  "CoworkerContractCoworkerId": 123,
  "CoworkerContractCoworkerFullName": "<string>",
  "CoworkerContractCoworkerBillingName": "<string>",
  "ProductId": 123,
  "ProductName": "<string>",
  "ProductPrice": 123,
  "ProductApplyProRating": true,
  "ProductCurrencyCode": "<string>",
  "Notes": "<string>",
  "Quantity": 123,
  "Price": 123,
  "RepeatFrom": "<string>",
  "RepeatUntil": "<string>",
  "ApplyProRating": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A ContractProduct is a product added to a contract that is billed every time the contract is invoiced. Use ContractProduct to append product charges to a specific member’s billing cycle alongside the base plan.

Price — If Price is not set, the price of the underlying product (ProductPrice) is used instead. Set Price to override the product’s default price for this specific contract line.

Billing window — RepeatFrom and RepeatUntil control the date range during which the product is included on invoices. Outside that range the product is silently skipped. Leave both null to bill the product on every invoice.

Pro-rating — ApplyProRating distributes the charge proportionally across the billing period, but only takes effect when the linked location plan has prorating enabled (Tariff.ProrateDaysBefore > 0). If the plan does not have prorating configured, ApplyProRating is ignored.

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 ContractProduct-Read role.

Path Parameters

id · integer · required

The Id of the ContractProduct record to retrieve.

Code Examples

cURL

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

Response

200

CoworkerContractId · integer

Contract to add this product to.

CoworkerContractQuantity · integer

Quantity associated with the contract.

CoworkerContractFloorPlanDeskIds · string

Floor plan desk IDs assigned to the contract.

CoworkerContractFloorPlanDeskNames · string

Floor plan desk names assigned to the contract.

CoworkerContractTariffName · string

Coworker contract tariff name.

CoworkerContractCoworkerId · integer

ID of the member on the contract.

CoworkerContractCoworkerFullName · string

Contract coworker full name.

CoworkerContractCoworkerBillingName · string

Contract coworker billing name.

ProductId · integer

Product to bill on each contract invoice.

ProductName · string

Product name.

ProductPrice · number

Product price.

ProductApplyProRating · boolean

Whether the underlying product applies pro-rating by default.

ProductCurrencyCode · string

Product currency code.

Notes · string

Notes.

Quantity · integer

Quantity.

Price · number

Price override.

RepeatFrom · string

Repeat from date.

RepeatUntil · string

Repeat until date.

ApplyProRating · boolean

Apply pro-rating to this product charge. Only takes effect when the location plan has prorating enabled (Tariff.ProrateDaysBefore > 0)..

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,
  "ProductId": 0,
  "ProductName": null,
  "ProductPrice": 0,
  "ProductApplyProRating": null,
  "ProductCurrencyCode": null,
  "Notes": null,
  "Quantity": 0,
  "Price": null,
  "RepeatFrom": null,
  "RepeatUntil": null,
  "ApplyProRating": false,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "[e-mail]",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "ContractProduct Example",
  "LocalizationDetails": null,
  "CustomFields": null
}