Name | Type | Description | Notes |
---|---|---|---|
id | **** | The invoice ID. | [optional] |
website_id | **** | The website ID. | |
invoice_number | Integer | An auto-incrementing number based on the sequence of invoices for any particular customer. | [optional] |
subscription_id | **** | The related order's ID if available, otherwise null. | [optional] |
currency | **** | ||
amount | Float | The invoice's amount. | [optional] |
amount_due | Float | The invoice's due amount. | [optional] |
subtotal_amount | Float | The invoice's subtotal amount. | [optional] |
discount_amount | Float | The invoice's discounts amount. | [optional] |
shipping | Shipping | [optional] | |
tax | InvoiceTax | [optional] | |
billing_address | **** | Invoice's billing address. | [optional] |
delivery_address | **** | Invoice's delivery address. | [optional] |
po_number | String | Purchase order number which will be displayed on the invoice. | [optional] |
notes | String | Notes for the customer which will be displayed on the invoice. | [optional] |
items | Array<InvoiceItem> | Invoice items array. | [optional] |
discounts | Array<null> | Discounts applied. | [optional] |
autopay_scheduled_time | DateTime | Invoice autopay scheduled time. | [optional] |
autopay_retry_number | Integer | Invoice autopay retry number. | [optional] [default to 0] |
status | String | Invoice status. | [optional] |
delinquent_collection_period | Integer | Delinquent collection period - difference between paidTime and dueTime in days. | [optional] |
collection_period | Integer | Collection period - difference between paidTime and issuedTime in days. | [optional] |
abandoned_time | **** | Invoice abandoned time. | [optional] |
voided_time | **** | Invoice voided time. | [optional] |
paid_time | **** | Invoice paid time. | [optional] |
due_time | DateTime | Invoice due time. | [optional] |
issued_time | **** | Invoice issued time. | [optional] |
created_time | **** | Invoice created time. | [optional] |
updated_time | **** | Invoice updated time. | [optional] |
payment_form_url | String | URL where the customer can be redirected to pay for the invoice with one of the methods which are available for this customer. It's an alternative to creating a new transaction with empty `methods`. | [optional] |
customer_id | **** | The customer ID. | |
transactions | Array<Transaction> | Invoice transactions array. | [optional] |
retry_instruction | InvoiceRetryInstruction | [optional] | |
revision | Integer | The number of times the invoice data has been modified. The revision is useful when analyzing webhook data to determine if the change takes precedence over the current representation. | [optional] |
type | String | Invoice type. | [optional] |
due_reminder_time | **** | Time past due reminder event will be triggered. | [optional] |
due_reminder_number | Integer | Number of past due reminder events triggered. | [optional] |
_links | Array<null> | The links related to resource. | [optional] |
_embedded | Array<null> | Any embedded objects available that are requested by the `expand` querystring parameter. | [optional] |