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 CoworkerBookingCredit is an amount of monetary credit assigned to a customer. Credits are typically created automatically when a customer’s contract on a plan that includes a TariffBookingCredit renews, but can also be created manually. Credit can be configured for two primary uses:

Bookings — set CaneBeUsedForBookings to allow the credit to pay for bookings. Use ElegibleResourceTypes to restrict the credit to specific resource types; if left empty the credit is valid for all resource types.
Events — set CaneBeUsedForEvents to allow the credit to pay for event sign-ups. Use EventCategories to restrict to specific event categories; if left empty the credit is valid for all events.

Setting IsUniversalCredit enables the credit for products, time passes, and other charges. Use ElegibleProducts, ElegiblePasses, and AppliesToCharges to restrict which products or passes the credit is valid for. If all restriction lists are empty the universal credit applies to all products, passes and charges. Use ValidFrom and ExpireDate to control the validity window of the credit.

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 credit is assigned to.

integer

required

ID of the location issuing the credit.

number

required

Total credit amount originally assigned.

Optional Fields

string

Optional description or label for this credit.

integer[]

Resource types this credit can be used for. If empty, the credit is valid for all resource types.

integer[]

Products this credit can be used for. If empty, applies to all products.

integer[]

Plans (tariffs) this credit is restricted to. If empty, applies to customers on any plan.

string

Date from which this credit is valid.

string

Date on which this credit expires.

boolean

Whether this credit can be used to pay for bookings. Restrict to specific resource types with ElegibleResourceTypes.

boolean

Whether this credit can be used to pay for event sign-ups. Restrict to specific categories with EventCategories.

integer[]

Event categories this credit can be used for. If empty, applies to all event categories.

boolean

Whether this is a universal credit applicable to products, time passes and other charges. Restrict with ElegibleProducts, ElegiblePasses and AppliesToCharges; if all are empty the credit applies to all products, passes and charges.

boolean

Whether to use the credit price instead of the standard booking price when this credit is applied.

string

Unique ID of the contract that originated this credit.

integer[]

Time passes this credit can be used for. If empty, applies to all passes.

boolean

Whether this universal credit applies to other charges.

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
}

Update CoworkerBookingCreditUpdate an existing CoworkerBookingCredit record.

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