> ## 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.

# Get one ContractProduct

> Retrieve a single ContractProduct record by its Id.

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

<Note>
  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.
</Note>

## Path Parameters

<ParamField path="id" type="integer" required>
  The Id of the ContractProduct record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractproducts/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractproducts/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractproducts/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CoworkerContractId" type="integer">
  Contract to add this product to.
</ResponseField>

<ResponseField name="CoworkerContractQuantity" type="integer">
  Quantity associated with the contract.
</ResponseField>

<ResponseField name="CoworkerContractFloorPlanDeskIds" type="string">
  Floor plan desk IDs assigned to the contract.
</ResponseField>

<ResponseField name="CoworkerContractFloorPlanDeskNames" type="string">
  Floor plan desk names assigned to the contract.
</ResponseField>

<ResponseField name="CoworkerContractTariffName" type="string">
  Coworker contract tariff name.
</ResponseField>

<ResponseField name="CoworkerContractCoworkerId" type="integer">
  ID of the member on the contract.
</ResponseField>

<ResponseField name="CoworkerContractCoworkerFullName" type="string">
  Contract coworker full name.
</ResponseField>

<ResponseField name="CoworkerContractCoworkerBillingName" type="string">
  Contract coworker billing name.
</ResponseField>

<ResponseField name="ProductId" type="integer">
  Product to bill on each contract invoice.
</ResponseField>

<ResponseField name="ProductName" type="string">
  Product name.
</ResponseField>

<ResponseField name="ProductPrice" type="number">
  Product price.
</ResponseField>

<ResponseField name="ProductApplyProRating" type="boolean">
  Whether the underlying product applies pro-rating by default.
</ResponseField>

<ResponseField name="ProductCurrencyCode" type="string">
  Product currency code.
</ResponseField>

<ResponseField name="Notes" type="string">
  Notes.
</ResponseField>

<ResponseField name="Quantity" type="integer">
  Quantity.
</ResponseField>

<ResponseField name="Price" type="number">
  Price override.
</ResponseField>

<ResponseField name="RepeatFrom" type="string">
  Repeat from date.
</ResponseField>

<ResponseField name="RepeatUntil" type="string">
  Repeat until date.
</ResponseField>

<ResponseField name="ApplyProRating" type="boolean">
  Apply pro-rating to this product charge. Only takes effect when the location plan has prorating enabled (Tariff.ProrateDaysBefore > 0)..
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "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": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "ContractProduct Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```