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

> Retrieve a single ContractPausedPeriod record by its Id.

A **ContractPausedPeriod** represents a freeze period applied to a customer's plan contract (`CoworkerContract`). Plan freezing lets admins — and optionally customers — suspend a contract for one or more billing cycles without cancelling it.

Freeze dates are always aligned to billing cycle boundaries: `PauseFrom` is always the first day of the customer's next billing cycle, and `PauseUntil` is always the first day of the billing cycle when the plan is due to restart.

While a contract is frozen:

* No charges are generated for the contract for the duration of the freeze.
* The customer's status reverts to **Contact** if they have no other active contract.
* No member rates or benefits from the frozen contract apply during the freeze.
* Invoices are still generated on the usual billing day for any purchases (bookings, products) linked to the contract.

Admins can freeze contracts from the customer's account, via teams, or in bulk from Finance > Contracts. Whether customers can freeze their own plans from the Members Portal is controlled by the `AllowContractFreezing` setting on the plan (`Tariff`).

## 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 **`ContractPausedPeriod-Read`** role.
</Note>

## Path Parameters

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

## Code Examples

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

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractpausedperiods/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/contractpausedperiods/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

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

## Response

### 200

<ResponseField name="CoworkerContractId" type="integer">
  ID of the customer contract being frozen.
</ResponseField>

<ResponseField name="CoworkerContractQuantity" type="integer">
  Quantity set on the frozen contract.
</ResponseField>

<ResponseField name="CoworkerContractFloorPlanDeskIds" type="string">
  Comma-separated IDs of the floor plan desks assigned to the frozen contract.
</ResponseField>

<ResponseField name="CoworkerContractFloorPlanDeskNames" type="string">
  Comma-separated names of the floor plan desks assigned to the frozen contract.
</ResponseField>

<ResponseField name="CoworkerContractTariffName" type="string">
  Name of the pricing plan (tariff) the frozen contract is for.
</ResponseField>

<ResponseField name="CoworkerContractCoworkerId" type="integer">
  ID of the customer holding the frozen contract.
</ResponseField>

<ResponseField name="CoworkerContractCoworkerFullName" type="string">
  Full name of the customer holding the frozen contract.
</ResponseField>

<ResponseField name="CoworkerContractCoworkerBillingName" type="string">
  Billing name of the customer holding the frozen contract.
</ResponseField>

<ResponseField name="Notes" type="string">
  Optional notes or reason for this freeze period.
</ResponseField>

<ResponseField name="PauseFrom" type="string">
  UTC date when the freeze starts. Always falls on the first day of a billing cycle.
</ResponseField>

<ResponseField name="PauseUntil" type="string">
  UTC date when the freeze ends. Always falls on the first day of the billing cycle when the plan is due to restart.
</ResponseField>

<ResponseField name="PauseFromLocal" type="string">
  Location-timezone equivalent of PauseFrom.
</ResponseField>

<ResponseField name="PauseUntilLocal" type="string">
  Location-timezone equivalent of PauseUntil.
</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,
  "Notes": null,
  "PauseFrom": "2025-01-15T10:30:00Z",
  "PauseUntil": "2025-01-15T10:30:00Z",
  "PauseFromLocal": null,
  "PauseUntilLocal": 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": "ContractPausedPeriod Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```