Get an invoice
GET
/v1/organizations/{orgId}/billing/invoices/{invoiceId}Authorization
AuthorizationBasic auth · headerrequiredRegistered confidential integration credentials. Keep the secret server-side.
or
CookieAPI key · headerrequiredConsole-managed Vault session cookie; secure cookie naming may vary by environment.
or
AuthorizationBearer token (Vault organization API key) · headerrequiredOrganization-owned credential with immutable mode and Read-only or Read/write permissions. Only explicitly declared ordinary customer operations accept it. Test business access refuses until shared Test composition is available; no staff, team, key-management or protocol authority is granted.
Path parameters
invoiceIdstringrequiredmax length 255 · matches ^in_[A-Za-z0-9_]+$
orgIdstringrequiredmin length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Responses
200
Success
dataobjectrequiredShow propertiesHide properties
amountDueintegerrequiredmin -9007199254740991 · max 9007199254740991
amountPaidintegerrequiredmin -9007199254740991 · max 9007199254740991
amountRemainingintegerrequiredmin -9007199254740991 · max 9007199254740991
createdAtstring<date-time>requiredmatches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
currencystringrequiredmatches ^[A-Z]{3}$
dueAtstring<date-time> | nullrequiredShow propertiesHide properties
Any of:
string<date-time>
string<date-time>null
nullfinalizedAtstring<date-time> | nullrequiredShow propertiesHide properties
Any of:
string<date-time>
string<date-time>null
nullidstringrequiredmax length 255 · matches ^in_[A-Za-z0-9_]+$
numberstring | nullrequiredpaidAtstring<date-time> | nullrequiredShow propertiesHide properties
Any of:
string<date-time>
string<date-time>null
nullperiodEndsAtstring<date-time>requiredmatches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
periodStartsAtstring<date-time>requiredmatches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
stateobjectrequiredShow propertiesHide properties
One of:
object
stagestringrequiredobject
stagestringrequiredstatusstringrequiredAllowed:
openpaiduncollectiblevoidobject
stagestringrequiredsubscriptionbooleansubtotalintegerrequiredmin -9007199254740991 · max 9007199254740991
totalintegerrequiredmin -9007199254740991 · max 9007199254740991
hostedInvoiceUrlstring<uri> | nullrequiredShow propertiesHide properties
Any of:
string<uri>
string<uri>null
nullpostPaymentCreditNotesAmountintegerrequiredmin -9007199254740991 · max 9007199254740991
prePaymentCreditNotesAmountintegerrequiredmin -9007199254740991 · max 9007199254740991
metaobjectrequiredShow propertiesHide properties
requestIdstringrequireddefault
Error
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
forbiddeninternal_errornot_foundprovider_data_invalidprovider_outcome_unknownprovider_unavailablerate_limitedstate_conflictunauthenticatedvalidation_errorwarehouse_not_readyfieldsobject[]Show propertiesHide properties
Array of
objectcodestringrequiredmessagestringrequiredpathstringrequiredmessagestringrequiredoperationIdstringmetaobjectrequiredShow propertiesHide properties
requestIdstringrequired