Create CoworkerBookingCredit

POST

api

billing

coworkerbookingcredits

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

import requests

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

payload = {
    "CoworkerId": 123,
    "BusinessId": 123,
    "TotalCredit": 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({CoworkerId: 123, BusinessId: 123, TotalCredit: 123})
};

fetch('https://spaces.nexudus.com/api/billing/coworkerbookingcredits', 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 booking credit (internally CoworkerBookingCredit) is a monetary balance assigned to a customer that can pay for bookings, event sign-ups, or, when universal credit is enabled, products, plans, passes, and selected one-off charges. It can be created manually or released from a plan or product benefit, and its availability can be limited by eligibility and a validity period.

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

Request Body

Required Fields

integer

required

ID of the customer this booking credit belongs to.

integer

required

ID of the location that issued and owns this booking credit.

number

required

Total monetary amount assigned when this credit is created; it sets the initial RemainingCredit.

Optional Fields

string

Optional operator-facing label or description for this booking credit.

integer[]

List of resource-type IDs this credit can pay for when CaneBeUsedForBookings is true; an empty list allows every resource type.

integer[]

List of product IDs this universal credit can pay for; when IsUniversalCredit is true, an empty list allows every product.

integer[]

List of plan IDs this universal credit can pay for; when IsUniversalCredit is true, an empty list allows every plan.

string

Optional UTC date and time when this credit becomes usable; blank means it is usable immediately.

string

Optional UTC date and time when this credit stops being usable; blank means no expiry, and when set it must be later than ValidFrom.

boolean

Whether this credit can pay for bookings; use ElegibleResourceTypes to limit eligible resource types.

boolean

Whether this credit can pay for event sign-ups; use EventCategories to limit eligible event categories.

integer[]

List of event-category IDs this credit can pay for when CaneBeUsedForEvents is true; an empty list allows every event category.

boolean

Whether this credit can pay for products, plans, passes, and eligible charges; use the eligibility lists and AppliesToCharges to restrict those uses.

string

Internal unique ID linking this credit to the contract that originated it.

integer[]

List of pass IDs this universal credit can pay for; when IsUniversalCredit is true, an empty list allows every pass.

boolean

Whether this universal credit can pay for one-off charges in addition to products, plans, and passes.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/billing/coworkerbookingcredits" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CoworkerId": 0,
    "BusinessId": 0,
    "TotalCredit": 0
}'

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

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/billing/coworkerbookingcredits',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'CoworkerId': 0,
        'BusinessId': 0,
        'TotalCredit': 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 coworkerbookingcredit was created successfully.

array

null on success.

Example Response

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

Create CoworkerBookingCredit

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

import requests

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

payload = {
    "CoworkerId": 123,
    "BusinessId": 123,
    "TotalCredit": 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({CoworkerId: 123, BusinessId: 123, TotalCredit: 123})
};

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