Create ContractProduct

POST

api

billing

contractproducts

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

import requests

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

payload = {
    "CoworkerContractId": 123,
    "ProductId": 123,
    "Quantity": 123
}
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, ProductId: 123, Quantity: 123})
};

fetch('https://spaces.nexudus.com/api/billing/contractproducts', 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 contract product (internally known as ContractProduct) is a recurring product line on a customer’s contract, billed with plan invoices and optionally controlled by a price override and billing window. When the product includes passes, booking time credit, monetary credit, or printing credit, those benefits are released as each contract invoice is created; configure the product’s credit expiration separately, either aligned with or independent of the billing cycle. A negative product price creates a discount shown as a negative invoice line; use ContractSchedule for a future contract price change instead. Do not use a contract product for a deposit: use ContractDeposit so it is invoiced only at contract start and can be refunded when appropriate.

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 ContractProduct-Create role.

Request Body

Required Fields

integer

required

ID of the customer’s contract; it determines the location and billing cycle that will receive this recurring product line..

integer

required

ID of the location product billed on the contract’s invoices; its current price is used when this line has no price override..

integer

required

Number of product units billed in each contract billing cycle; must be at least 1..

Optional Fields

string

Optional operator notes about this recurring product line..

number

Optional per-unit price override in the location’s currency; when null, the linked product’s price is used..

string

Optional UTC date and time for the first invoice period that includes this product line; inclusive, and null starts billing immediately..

string

Optional UTC date and time for the first invoice period that excludes this product line; exclusive, and null continues billing indefinitely..

boolean

Whether this line requests prorating when it ends during an invoice period; the product’s setting can also enable prorating, and the contract plan must have ProrateDaysBefore configured..

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/billing/contractproducts" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CoworkerContractId": 0,
    "ProductId": 0,
    "Quantity": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/contractproducts',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      CoworkerContractId: 0,
      ProductId: 0,
      Quantity: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/billing/contractproducts',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'CoworkerContractId': 0,
        'ProductId': 0,
        'Quantity': 0
    }
)

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 contractproduct was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "ContractProduct 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": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}

Create ContractProduct

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

import requests

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

payload = {
    "CoworkerContractId": 123,
    "ProductId": 123,
    "Quantity": 123
}
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, ProductId: 123, Quantity: 123})
};

fetch('https://spaces.nexudus.com/api/billing/contractproducts', 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