ContractPausedPeriods
Get one ContractPausedPeriod
Retrieve a single ContractPausedPeriod record by its Id.
GET
Get one ContractPausedPeriod
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.
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
Code Examples
Response
200
UTC date when the freeze ends. Always falls on the first day of the billing cycle when the plan is due to restart.
Example Response