Create BusinessCharge

POST

api

billing

businesscharges

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/businesscharges \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Description": "<string>",
  "CallBackUrl": "<string>",
  "PercentageDiscount": 123,
  "TotalAmount": 123,
  "TaxAmount": 123
}
'

import requests

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

payload = {
    "BusinessId": 123,
    "Description": "<string>",
    "CallBackUrl": "<string>",
    "PercentageDiscount": 123,
    "TotalAmount": 123,
    "TaxAmount": 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({
    BusinessId: 123,
    Description: '<string>',
    CallBackUrl: '<string>',
    PercentageDiscount: 123,
    TotalAmount: 123,
    TaxAmount: 123
  })
};

fetch('https://spaces.nexudus.com/api/billing/businesscharges', 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 BusinessCharge represents a charge issued by Nexudus to a specific location for platform services or subscription fees. Only Nexudus staff can create or manage these charges. Charges can be one-off or recurring. Set Recurrent to true and provide RepeatFrom and RepeatUntil to define the recurrence window. A charge moves through an approval workflow before it is invoiced. Use ApprovedByBusiness and ApprovedBySender to reflect the approval state. Once invoiced, the Invoiced flag will be set and InvoicedOn will record the date.

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

Request Body

Required Fields

integer

required

ID of the business linked to this record.

string

required

Human-readable description of what this charge is for.

string

required

URL that Nexudus will call back once the charge is processed or its status changes.

number

required

Percentage discount to apply to the charge amount (0–100).

number

required

Total amount of the charge before tax.

number

required

Tax amount applied to this charge.

Optional Fields

integer

ID of the application linked to this record.

string

Date by which the charge must be paid.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/billing/businesscharges" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Description": "",
    "CallBackUrl": "",
    "PercentageDiscount": 0,
    "TotalAmount": 0,
    "TaxAmount": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/businesscharges',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      Description: '',
      CallBackUrl: '',
      PercentageDiscount: 0,
      TotalAmount: 0,
      TaxAmount: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/billing/businesscharges',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Description': '',
        'CallBackUrl': '',
        'PercentageDiscount': 0,
        'TotalAmount': 0,
        'TaxAmount': 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 businesscharge was created successfully.

array

null on success.

Example Response

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

Update BusinessChargeUpdate an existing BusinessCharge record.

Create BusinessCharge

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/businesscharges \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Description": "<string>",
  "CallBackUrl": "<string>",
  "PercentageDiscount": 123,
  "TotalAmount": 123,
  "TaxAmount": 123
}
'

import requests

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

payload = {
    "BusinessId": 123,
    "Description": "<string>",
    "CallBackUrl": "<string>",
    "PercentageDiscount": 123,
    "TotalAmount": 123,
    "TaxAmount": 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({
    BusinessId: 123,
    Description: '<string>',
    CallBackUrl: '<string>',
    PercentageDiscount: 123,
    TotalAmount: 123,
    TaxAmount: 123
  })
};

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