Cancel usages

Cancellation of multiple pooled or unpooled usages that must all be assigned to the same contract. The request is processed atomically: either every usage is cancelled and corrected, or nothing is changed. Pooled usages are corrected according to the correction mode of the billing group: item-based with one correction per pool, document-based by cancelling and reissuing every affected document. Rejections of the request return 400 with a machine-readable reason code. 409 is returned when a concurrent change of the same pool committed first; the request can be repeated. 423 is returned when an affected pool is currently being billed or only exists as a not yet billed copy; the request can be repeated once billing has completed. 423 is also returned when an affected pool was terminated manually (TERMINATED); such a pool is not cancellable.

Body Params

A request to cancel multiple usages together

cancellationRequests
array of objects
required
length ≥ 1

Usages to be cancelled.
Must not be empty.

cancellationRequests*

This request contains the ident of a usage that shall be cancelled

string
required
length ≥ 1

Ident of the usage that shall be cancelled.
Must not be empty.

string | null

The reason for cancellation.
Size must be between 0 and 255.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Choose an example:
application/json