Updates an existing Charge 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 Charge-Edit role.
Request Body
Required Fields
The Id of the Charge record to update.
Optional Fields
Display text on invoice line.
Whether this is a regular charge.
Whether the charge has been invoiced.
Coworker Extra Service Name.
Coworker Product Unique Id.
Code Examples
curl -X PUT \
"https://spaces.nexudus.com/api/billing/charges" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"CoworkerId": 0,
"BusinessId": 0,
"Quantity": 0,
"DiscountAmount": 0,
"CreditAmount": 0,
"TotalAmount": 0,
"Id": 87654321
}'
Response
200
HTTP status code. 200 on success.
A human-readable message confirming the update.
Contains the Id of the updated record.
true if the charge was updated successfully.
{
"Status" : 200 ,
"Message" : "Charge 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
A summary of the validation error(s), in the format PropertyName: error message.
null on validation failure.
Array of validation errors. The value that was submitted for the field, or null if missing.
The validation error message.
The name of the property that failed validation.
false when the request fails validation.
{
"Message" : "DiscountAmount: is a required field" ,
"Value" : null ,
"Errors" : [
{
"AttemptedValue" : null ,
"Message" : "is a required field" ,
"PropertyName" : "DiscountAmount"
}
],
"WasSuccessful" : false
}