Create ContractPausedPeriod

POST

api

billing

contractpausedperiods

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/contractpausedperiods \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CoworkerContractId": 123,
  "PauseFrom": "<string>",
  "PauseUntil": "<string>"
}
'

import requests

url = "https://spaces.nexudus.com/api/billing/contractpausedperiods"

payload = {
    "CoworkerContractId": 123,
    "PauseFrom": "<string>",
    "PauseUntil": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({CoworkerContractId: 123, PauseFrom: '<string>', PauseUntil: '<string>'})
};

fetch('https://spaces.nexudus.com/api/billing/contractpausedperiods', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<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-Create role.

Request Body

Required Fields

integer

required

ID of the customer contract being frozen.

string

required

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

string

required

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

Optional Fields

string

Optional notes or reason for this freeze period.

string

Location-timezone equivalent of PauseFrom.

string

Location-timezone equivalent of PauseUntil.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/billing/contractpausedperiods" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CoworkerContractId": 0,
    "PauseFrom": "2025-01-15T10:30:00Z",
    "PauseUntil": "2025-01-15T10:30:00Z"
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/contractpausedperiods',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      CoworkerContractId: 0,
      PauseFrom: '2025-01-15T10:30:00Z',
      PauseUntil: '2025-01-15T10:30:00Z'
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/billing/contractpausedperiods',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'CoworkerContractId': 0,
        'PauseFrom': '2025-01-15T10:30:00Z',
        'PauseUntil': '2025-01-15T10:30:00Z'
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the contractpausedperiod was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "ContractPausedPeriod was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "PauseFrom: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "PauseFrom"
    }
  ],
  "WasSuccessful": false
}

Update ContractPausedPeriodUpdate an existing ContractPausedPeriod record.

Create ContractPausedPeriod

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/contractpausedperiods \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CoworkerContractId": 123,
  "PauseFrom": "<string>",
  "PauseUntil": "<string>"
}
'

import requests

url = "https://spaces.nexudus.com/api/billing/contractpausedperiods"

payload = {
    "CoworkerContractId": 123,
    "PauseFrom": "<string>",
    "PauseUntil": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({CoworkerContractId: 123, PauseFrom: '<string>', PauseUntil: '<string>'})
};

fetch('https://spaces.nexudus.com/api/billing/contractpausedperiods', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400