Skip to main content
GET
Retrieve an invoice.

Authorizations

Authorization
string
header
required

Enter your access token (OAuth / JWT).

Path Parameters

invoiceUid
string | null
required

The invoice's unique identifier

Response

Created
string<date-time>
required
read-only
Minimum string length: 1
Updated
string<date-time>
required
read-only
Minimum string length: 1
Uid
string | null
Maximum string length: 10
_objectType
string | null
ActivityEventData
unknown
SchemaLessData
object | null
StripeId
string | null
Maximum string length: 255
IsLivemode
boolean
AmountDue
integer<int64>
AmountPaid
integer<int64>
AmountShipping
integer<int64>
AttemptCount
integer<int64>
Attempted
boolean
Currency
string | null
Maximum string length: 3
Description
string | null
FinalizedAt
string<date-time> | null
HostedInvoiceUrl
string | null
Maximum string length: 500
InvoicePdf
string | null
Maximum string length: 500
NextPaymentAttempt
string<date-time> | null
Number
string | null
Maximum string length: 50
PeriodEnd
string<date-time>
PeriodStart
string<date-time>
Status
string | null
Maximum string length: 30
StripeDiscounts
object[] | null
StripeInvoiceDiscountAmounts
object[] | null
StripeInvoiceLineItems
object[] | null
StripeInvoicePayments
object[] | null
SubTotal
integer<int64>
SubTotalExcludingTax
integer<int64> | null
SubscriptionId
string | null
Maximum string length: 255
Tax
integer<int64> | null
Total
integer<int64>
TotalExcludingTax
integer<int64> | null
Account
Account · object | null

Circular reference to Account (not expanded here).

IsImported
boolean
IsRefunded
boolean
CurrencyAmountCreditedPostPayment
number<decimal>
CurrencyAmountCreditedPrePayment
number<decimal>
CurrencyAmountDue
number<decimal>
CurrencyAmountPaid
number<decimal>
CurrencySymbol
string | null
CurrencyTotal
number<decimal>
CurrencyTotalExcludingTax
number<decimal>
CurrencySubTotal
number<decimal>
CurrencySubTotalExcludingTax
number<decimal>
CurrencyTax
number<decimal>
DaysUntilDue
integer<int64> | null
CustomerId
string | null
PaymentStatus
string | null
StripeCreditNotes
object[] | null
StripePaymentMethodId
string | null