Mark invoice as uncollectible

Marks an open (or applicable) invoice as uncollectible. The invoice must belong to the merchant account resolved from the secret key. Response data matches the invoice-by-id shape (including optional expand for nested objects). On success, status is uncollectible, markedUncollectibleOn is set, autoAdvance is false, and nextPaymentAttempt is null as enforced by the payment service. Line-item price, accountDiscounts, and accountFees follow the same expand pattern as GET invoice.

Path Params
string
required
length between 10 and 128

Invoice ID to mark uncollectible. Must be valid, not soft deleted, and belong to the merchant account.

Headers
string
required

Secret key associated to the partner's account (e.g. sk_age14sf40sSwfchDsaetaqsgh3001e4gf2ed)

string

(Optional) AccountId of the merchant that owns the invoice (e.g. acm_********). Only required when secretKey belongs to an "entity" account.

string

Unique Key String refNumber

string

Unique key generated by the partner (e.g. 490ff93e-8a73-4aa4-a02b-9d9251f91243)

Responses

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