Record
invoice
No description available.
record invoice {
account-country: option<string>,
account-name: option<string>,
account-tax-ids: option<list<string>>,
amount-due: s32,
amount-paid: s32,
amount-remaining: s32,
amount-shipping: s32,
application: option<string>,
application-fee-amount: option<s32>,
attempt-count: s32,
attempted: bool,
auto-advance: option<bool>,
automatic-tax: automatic-tax,
billing-reason: option<invoice-billing-reason-enum>,
charge: option<string>,
collection-method: get-invoices-collection-method-enum,
created: s32,
currency: string,
custom-fields: option<list<invoice-setting-custom-field>>,
customer: option<string>,
customer-address: option<string>,
customer-email: option<string>,
customer-name: option<string>,
customer-phone: option<string>,
customer-shipping: option<string>,
customer-tax-exempt: option<invoice-customer-tax-exempt-enum>,
customer-tax-ids: option<list<resource-invoice-tax-id>>,
default-payment-method: option<string>,
default-source: option<string>,
default-tax-rates: list<tax-rate>,
description: option<string>,
discount: option<string>,
discounts: option<list<string>>,
due-date: option<s32>,
ending-balance: option<s32>,
footer: option<string>,
from-invoice: option<string>,
hosted-invoice-url: option<string>,
id: option<string>,
invoice-pdf: option<string>,
last-finalization-error: option<string>,
latest-revision: option<string>,
lines: invoice-lines,
livemode: bool,
metadata: option<invoice-metadata>,
next-payment-attempt: option<s32>,
number: option<string>,
object: invoice-object-enum,
on-behalf-of: option<string>,
paid: bool,
paid-out-of-band: bool,
payment-intent: option<string>,
payment-settings: payment-settings,
period-end: s32,
period-start: s32,
post-payment-credit-notes-amount: s32,
pre-payment-credit-notes-amount: s32,
quote: option<string>,
receipt-number: option<string>,
rendering-options: option<string>,
shipping-cost: option<string>,
shipping-details: option<string>,
starting-balance: s32,
statement-descriptor: option<string>,
status: option<get-invoices-status-enum>,
status-transitions: status-transitions,
subscription: option<string>,
subscription-proration-date: option<s32>,
subtotal: s32,
subtotal-excluding-tax: option<s32>,
tax: option<s32>,
test-clock: option<string>,
threshold-reason: option<invoice-threshold-reason>,
total: s32,
total-discount-amounts: option<list<discounts-resource-discount-amount>>,
total-excluding-tax: option<s32>,
total-tax-amounts: list<invoice-tax-amount>,
transfer-data: option<string>,
webhooks-delivered-at: option<s32>,
}Fields
| Name | Type | Description |
|---|---|---|
| account-country | option<string> | |
| account-name | option<string> | |
| account-tax-ids | option<list<string>> | |
| amount-due | s32 | |
| amount-paid | s32 | |
| amount-remaining | s32 | |
| amount-shipping | s32 | |
| application | option<string> | |
| application-fee-amount | option<s32> | |
| attempt-count | s32 | |
| attempted | bool | |
| auto-advance | option<bool> | |
| automatic-tax | automatic-tax | |
| billing-reason | option<invoice-billing-reason-enum> | |
| charge | option<string> | |
| collection-method | get-invoices-collection-method-enum | |
| created | s32 | |
| currency | string | |
| custom-fields | option<list<invoice-setting-custom-field>> | |
| customer | option<string> | |
| customer-address | option<string> | |
| customer-email | option<string> | |
| customer-name | option<string> | |
| customer-phone | option<string> | |
| customer-shipping | option<string> | |
| customer-tax-exempt | option<invoice-customer-tax-exempt-enum> | |
| customer-tax-ids | option<list<resource-invoice-tax-id>> | |
| default-payment-method | option<string> | |
| default-source | option<string> | |
| default-tax-rates | list<tax-rate> | |
| description | option<string> | |
| discount | option<string> | |
| discounts | option<list<string>> | |
| due-date | option<s32> | |
| ending-balance | option<s32> | |
| footer | option<string> | |
| from-invoice | option<string> | |
| hosted-invoice-url | option<string> | |
| id | option<string> | |
| invoice-pdf | option<string> | |
| last-finalization-error | option<string> | |
| latest-revision | option<string> | |
| lines | invoice-lines | |
| livemode | bool | |
| metadata | option<invoice-metadata> | |
| next-payment-attempt | option<s32> | |
| number | option<string> | |
| object | invoice-object-enum | |
| on-behalf-of | option<string> | |
| paid | bool | |
| paid-out-of-band | bool | |
| payment-intent | option<string> | |
| payment-settings | payment-settings | |
| period-end | s32 | |
| period-start | s32 | |
| post-payment-credit-notes-amount | s32 | |
| pre-payment-credit-notes-amount | s32 | |
| quote | option<string> | |
| receipt-number | option<string> | |
| rendering-options | option<string> | |
| shipping-cost | option<string> | |
| shipping-details | option<string> | |
| starting-balance | s32 | |
| statement-descriptor | option<string> | |
| status | option<get-invoices-status-enum> | |
| status-transitions | status-transitions | |
| subscription | option<string> | |
| subscription-proration-date | option<s32> | |
| subtotal | s32 | |
| subtotal-excluding-tax | option<s32> | |
| tax | option<s32> | |
| test-clock | option<string> | |
| threshold-reason | option<invoice-threshold-reason> | |
| total | s32 | |
| total-discount-amounts | option<list<discounts-resource-discount-amount>> | |
| total-excluding-tax | option<s32> | |
| total-tax-amounts | list<invoice-tax-amount> | |
| transfer-data | option<string> | |
| webhooks-delivered-at | option<s32> |