Request billing adjustments

Requests one or more invoice adjustments (refunds) in a single call.

Each entry is evaluated independently. The response is 202 Accepted with
billingAdjustments for accepted entries and errors for rejected entries.
Match each result to its request entry by clientToken. A response with an
empty billingAdjustments array means every entry failed.

Accepted entries start at PENDING. Processing can take up to 72 hours.
Poll the list endpoint or subscribe to the agreement_billing_adjustment_updated
webhook for status updates.

clientToken is the idempotency key for each entry. Reusing a token returns
the original result instead of creating a duplicate.

Each adjustmentAmount is an unsigned magnitude (for example, "200.00").
It must not exceed the invoice's pricingCurrencyAmount.maxAdjustmentAmount,
and currencyCode must match the invoice currency. Amount or currency
violations appear as per-entry errors in the 202 response, not as a
request-level 400.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 64
^[A-Za-z0-9_/-]+$

Agreement identifier

Body Params
billingAdjustments
array of objects
required
length between 1 and 5

Adjustments to request. Each entry is evaluated independently. Maximum 5
entries per request.

billingAdjustments*
string
required
length ≤ 64
^[a-zA-Z0-9-]+$

Idempotency key for this entry. Also matches this entry to its result or
error in the response. Must be unique within the request.

string
required
length ≤ 255

The invoice to adjust

string
required
^[0-9]+(\.[0-9]{1,8})?$

Unsigned refund amount as a decimal string. Up to 8 decimal places. Must not
exceed the invoice's pricingCurrencyAmount.maxAdjustmentAmount.

string
required
length between 3 and 3

ISO 4217 code. Must match the invoice currency.

string
enum
required

Why you are requesting the adjustment. Not interchangeable with cancellation
reason codes.

Allowed:
string
length ≤ 500

Optional note included with the request

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json