Update invoice custom properties
Merge custom property values onto an invoice (send a key with null to remove it).
Values are validated against the tenant’s INVOICE property definitions. Allowed at any
status — custom properties are external workflow metadata and stay editable after the invoice
is finalized.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Invoice ID
"inv_7n42DGM5Tflk9n8mt7Fhc7"
Body
Merge update of an invoice's custom property values (send a key with null to remove it).
Allowed at any status — custom properties stay editable after the invoice is finalized.
Response
Updated invoice
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNH, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZWL "EUR"
User-defined custom property values, keyed by definition key.
"cus_7n42DGM5Tflk9n8mt7Fhc7"
"inv_7n42DGM5Tflk9n8mt7Fhc7"
RECURRING, ONE_OFF, ADJUSTMENT, USAGE_THRESHOLD UNPAID, PARTIALLY_PAID, PAID, ERRORED, PROCESSING DRAFT, FINALIZED, UNCOLLECTIBLE, VOID, CLOSED The period/moment this invoice is about — the subscription period start, or the invoice's
own date for manual/one-off. Stable and always present, distinct from invoice_date (the
emission date). Shown as "Invoice date".
Set on a cancelled invoice that has been reissued: the corrective invoice replacing it.
"inv_7n42DGM5Tflk9n8mt7Fhc7"
Set on a corrective invoice: the cancelled invoice this one replaces ("cancels and replaces"). The original is credited in full by a credit note.
"inv_7n42DGM5Tflk9n8mt7Fhc7"
"sub_7n42DGM5Tflk9n8mt7Fhc7"