GET
Export an invoice

Authorizations

Authorization
string
header
required

sk_test_ / sk_live_ / rk_test_ / rk_live_ keys

Headers

Shipping-Version
string
Shipping-Account
string

Act on behalf of a connected account (acct_...)

Path Parameters

id
string
required

Query Parameters

format
enum<string>
Available options:
edi_210,
edifact_invoic,
ubl,
carrier_csv,
json,
csv

Response

Invoice in the requested format

id
string
required

Prefixed invc_

Example:

"invc_1Q2w3E4r"

object
enum<string>
required
Available options:
invoice
livemode
boolean
required
created
integer<unix-time>
required

Unix timestamp (seconds)

kind
enum<string>
required
Available options:
transport,
usage,
settlement,
duties,
subscription,
credit_note
status
enum<string>
required
Available options:
draft,
open,
partially_paid,
paid,
overdue,
disputed,
void,
uncollectible
currency
string
required
lines
object[]
required
totals
object
required
updated
integer<unix-time>

Unix timestamp (seconds)

direction
enum<string>
Available options:
payable,
receivable
issuer
object
recipient
object
number
string | null
issued_on
string<date> | null
due_on
string<date> | null
period
object | null
reconciliation
object | null
source
object
documents
object[]
payments
string[]
external_ids
object[]
user_metadata
object

Client-writable. Up to 50 string key/value pairs. Never sent to carriers.

carrier_metadata
object
read-only

Read-only. Carrier-returned data not modelled by the spec (routing codes, internal IDs). Untrusted and unversioned; keys may change with the carrier's API.

system_metadata
object
read-only

Read-only. Implementer provenance. Implementer-specific keys are prefixed x_.