API
Checking Raims account

Update an existing charge

Update the title, description and integration data of a charge.

PATCHhttps://api.raims.com/v1/charges/{id}

Updates the title, description, external reference and metadata of an existing charge. Use the identifier received when creating or looking up the charge, in the company and environment of your API key.

Send only the fields you want to change. Omitted fields keep their current value; for text fields, null or empty text clears the field you send. An empty body ({}) keeps the data. Amount, due date and linked customer remain as defined at creation.

The metadata map is updated by key. See how to add or remove values in Additional integration data.

Editing is allowed for charges that remain open, including after their due date. Paid, canceled, refunded charges or charges in other final states only allow changes to metadata. If you mix this data with other fields in a request rejected because of the state, nothing is changed. See the editing and replacement rules in Update a charge. To associate the charge with your system, see Reference in your system.

Path Params

The charge's public identifier in Raims, received when creating or listing charges.

Up to 100 characters

Body Params

Charge title. Omit it to keep the current title; send null or empty text to remove it.

Up to 512 characters

Charge description. Omit it to keep the current description; send null or empty text to remove it.

Up to 512 characters

Order or charge reference in your system. Omit it to keep the current value; send null or empty text to remove it. It can be repeated on other charges and is separate from the customer reference.

Up to 120 characters

Integration data associated with the resource. Provide key and text pairs. Keys are case-sensitive. Omitting it or sending {} keeps the data; null removes all pairs, and null for a key removes only that key. Empty text is a valid value.

Up to 32 entries, Keys: up to 40 characters, Values: up to 500 characters, JSON: up to 8192 UTF-8 bytes

Responses

For common errors, see HTTP response codes.