Skip to content

Read invoice details

Read the account details used on invoices and receipts.

Parameters

#
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.

Returns

#
dataobjectAlways present
The account's invoice identity and contact details.
Show 4 attributesHide attributes
companystringAlways present
Company name for invoices, or empty when none is set.
emailstringAlways present
Billing email address.
postal_addressobject
Postal address used on invoices. May be omitted.
Show 6 attributesHide attributes
citystring
City or locality. May be omitted.
countrystringAlways present
Two-letter country code.
line1stringAlways present
Street address.
line2string
Additional address details, such as an apartment or suite. May be omitted.
postal_codestring
Postal or ZIP code. May be omitted.
statestring
State, province or region. May be omitted.
tax_idstringAlways present
Tax identifier as TYPE:VALUE, or empty without one.

Errors

#
CodeStatusWhat happened
invalid400An input is missing or invalid.
unauthenticated401The credential is missing, invalid, expired or revoked.
denied403The caller lacks permission for this action.
not_found404The resource is absent or inaccessible to this caller.
conflict409The request conflicts with the current resource state or an earlier request.
over_capacity409The request exceeds a resource or credential allowance.
access_list_full409The change would exceed the access-list allowance.
rate_limited429The caller's request rate exceeds its limit.
busy429Too much work is in progress to accept this request.
unknown503The outcome is unconfirmed; a change may have happened.
unavailable503The service or requested feature is unavailable.

Notes

#
  • API key permission: billing details view.