Skip to main content
PUT
/
api
/
billing
/
productbookingcredits
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
Updates an existing ProductBookingCredit record. You must include the Id of the record to update along with all required fields.

​
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-Edit role.

​
Request Body

​
Required Fields

​
Id
integer
required
The Id of the ProductBookingCredit record to update.
​
Name
string
required
Credit name.
​
ProductId
integer
required
Product Id.
​
Credit
number
required
Credit amount.

​
Optional Fields

​
ElegibleResourceTypes
integer[]
Elegible Resource Types.
​
AddedElegibleResourceTypes
integer[]
Added Elegible Resource Types.
​
RemovedElegibleResourceTypes
integer[]
Removed Elegible Resource Types.
​
ElegibleProducts
integer[]
Elegible Products.
​
AddedElegibleProducts
integer[]
Added Elegible Products.
​
RemovedElegibleProducts
integer[]
Removed Elegible Products.
​
ElegibleTariffs
integer[]
Elegible Tariffs.
​
AddedElegibleTariffs
integer[]
Added Elegible Tariffs.
​
RemovedElegibleTariffs
integer[]
Removed Elegible Tariffs.
​
ExpireTimeInMonths
integer
Expire Time In Months.
​
ExpireTimeInWeeks
integer
Expire Time In Weeks.
​
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[]
Event Categories.
​
AddedEventCategories
integer[]
Added Event Categories.
​
RemovedEventCategories
integer[]
Removed Event Categories.
​
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[]
Elegible Passes.
​
AddedElegiblePasses
integer[]
Added Elegible Passes.
​
RemovedElegiblePasses
integer[]
Removed Elegible Passes.
​
AppliesToCharges
boolean
Whether this universal credit applies to other charges.

​
Code Examples

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

​
Response

​
200

​
Status
integer
HTTP status code. 200 on success.
​
Message
string
A human-readable message confirming the update.
​
Value
object
Contains the Id of the updated record.
​
WasSuccessful
boolean
true if the productbookingcredit was updated successfully.
​
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "ProductBookingCredit was successfully updated.",
  "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

​
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.
​
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
}