Update ContractPausedPeriod

PUT

api

billing

contractpausedperiods

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

import requests

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

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

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    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>"
    }
  ]
}

Updates an existing ContractPausedPeriod record. You must include the Id of the record to update along with all required fields.

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-Edit role.

Request Body

Required Fields

integer

required

The Id of the ContractPausedPeriod record to update.

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 PUT \
  "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",
    "Id": 87654321
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/contractpausedperiods',
  {
    method: 'PUT',
    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',
      Id: 87654321
    })
  }
);

const data = await response.json();

import requests

response = requests.put(
    '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',
        'Id': 87654321
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the update.

object

Contains the Id of the updated record.

boolean

true if the contractpausedperiod was updated successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "ContractPausedPeriod was successfully updated.",
  "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
}

Delete ContractPausedPeriodDelete an existing ContractPausedPeriod record by its Id.

Update ContractPausedPeriod

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

import requests

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

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

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    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