Create ProductBookingCredit

Create a new ProductBookingCredit record.

POST /api/billing/productbookingcredits

Create ProductBookingCredit

cURL

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

200

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

A ProductBookingCredit represents an amount of credit linked to a Product. When a customer purchases the product, the credit is automatically released as a CoworkerBookingCredit on the customer’s account.

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 ExpirationType and ExpiresIn to control when the released credit expires.

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

Enums

eRecurrentChargePattern

Value	Name
1	PricePlan
2	Day
3	Week
4	Month
5	Year
6	LastDayOfMonth

Request Body

Required Fields

Name · string · required

Credit name.

ProductId · integer · required

ID of the product linked to this record.

Credit · number · required

Credit amount.

Optional Fields

ElegibleResourceTypes · integer[]

List of elegible resource types linked to this record.

ElegibleProducts · integer[]

List of elegible products linked to this record.

ElegibleTariffs · integer[]

List of elegible tariffs linked to this record.

ExpireTimeInMonths · integer

The expire time in months value for this product booking credit.

ExpireTimeInWeeks · integer

The expire time in weeks value for this product booking credit.

CaneBeUsedForBookings · boolean

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

CaneBeUsedForEvents · boolean

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

EventCategories · integer[]

List of event categories linked to this record.

ExpirationType · integer

Expiration type. See eRecurrentChargePattern? enum above.

ExpiresIn · integer

Number of periods (of ExpirationType) until the released credit expires.

IsUniversalCredit · 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.

ElegiblePasses · integer[]

List of elegible passes linked to this record.

AppliesToCharges · boolean

Whether this universal credit applies to other charges.

Code Examples

cURL

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

Response

200

Status · integer

HTTP status code. 200 on success.

Message · string

A human-readable message confirming the creation.

Value · object

Contains the Id of the newly created record.

WasSuccessful · boolean

true if the productbookingcredit was created successfully.

Errors · array

null on success.

Example Response

{
  "Status": 200,
  "Message": "ProductBookingCredit was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "[e-mail]",
  "Errors": null,
  "WasSuccessful": true
}

400

Message · string

A summary of the validation error(s), in the format PropertyName: error message.

Value · any

null on validation failure.

Errors · object[]

Array of validation errors.

Show child attributes

AttemptedValue · any

The value that was submitted for the field, or null if missing.

Message · string

The validation error message.

PropertyName · string

The name of the property that failed validation.

WasSuccessful · 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
}