Get one ContractPausedPeriod

Retrieve a single ContractPausedPeriod record by its Id.

GET /api/billing/contractpausedperiods/{id}

Get one ContractPausedPeriod

cURL

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

200

{
  "CoworkerContractId": 123,
  "CoworkerContractQuantity": 123,
  "CoworkerContractFloorPlanDeskIds": "<string>",
  "CoworkerContractFloorPlanDeskNames": "<string>",
  "CoworkerContractTariffName": "<string>",
  "CoworkerContractCoworkerId": 123,
  "CoworkerContractCoworkerFullName": "<string>",
  "CoworkerContractCoworkerBillingName": "<string>",
  "Notes": "<string>",
  "PauseFrom": "<string>",
  "PauseUntil": "<string>",
  "PauseFromLocal": "<string>",
  "PauseUntilLocal": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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

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.

Path Parameters

id · integer · required

The Id of the ContractPausedPeriod record to retrieve.

Code Examples

cURL

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

Response

200

CoworkerContractId · integer

ID of the customer contract being frozen.

CoworkerContractQuantity · integer

Quantity set on the frozen contract.

CoworkerContractFloorPlanDeskIds · string

Comma-separated IDs of the floor plan desks assigned to the frozen contract.

CoworkerContractFloorPlanDeskNames · string

Comma-separated names of the floor plan desks assigned to the frozen contract.

CoworkerContractTariffName · string

Name of the pricing plan (tariff) the frozen contract is for.

CoworkerContractCoworkerId · integer

ID of the customer holding the frozen contract.

CoworkerContractCoworkerFullName · string

Full name of the customer holding the frozen contract.

CoworkerContractCoworkerBillingName · string

Billing name of the customer holding the frozen contract.

Notes · string

Optional notes or reason for this freeze period.

PauseFrom · string

UTC date when the freeze starts. Always falls on the first day of a billing cycle.

PauseUntil · string

UTC date when the freeze ends. Always falls on the first day of the billing cycle when the plan is due to restart.

PauseFromLocal · string

Location-timezone equivalent of PauseFrom.

PauseUntilLocal · string

Location-timezone equivalent of PauseUntil.

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,
  "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": "[e-mail]",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "ContractPausedPeriod Example",
  "LocalizationDetails": null,
  "CustomFields": null
}