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
InvoiceDate
string<date-time>
PaymentReminderSentDate
string<date-time> | null
Number
integer<int32>
BillingInvoiceStatus
enum<integer>

1 - Unpaid, 2 - Paid, 3 - Partial, 4 - Uncollected, 5 - Refunded, 6 - Uncollectible, 7 - Processing

Available options:
1,
2,
3,
4,
5,
6,
7
Subscription
Subscription · object | null

Circular reference to Subscription (not expanded here).

Amount
number<decimal>
AmountOutstanding
number<decimal>
InvoiceLineItems
object[] | null
IsUserGenerated
boolean
StripeTaxCalculationId
string | null
Maximum string length: 50
StripeTaxBehavior
string | null
Maximum string length: 10
AmountCredit
number<decimal>
AmountDiscount
number<decimal>
AmountPaid
number<decimal>
AmountRefunded
number<decimal>
AmountSubtotal
number<decimal>
AmountTax
number<decimal>
AmountTaxRefunded
number<decimal>
IsTaxable
boolean
HasPaymentGatewayTransactions
boolean
StripePaymentTransactionIds
string | null
StripeRefundTransactionIds
string | null
StripeTaxRefundTransactionIds
string | null