Invoice Object
id string A unique identifier for the invoice.
object string The value is always invoice.
currency string Currency code The currency of the invoice.
paid boolean Displays whether the invoice is paid.
type string The possible values are checkout, custom, recurring and payout.
prefix string The invoice prefix.
number integer The invoice number.
total integer The total invoice amount.
payment string payment code The payment method of the invoice.
date timestamp The date the invoice was purchased.
due_date timestamp The due date of the invoice. Available for invoices with type custom and recurring.
status string The invoice status. The possible values can be found here
subscription string The id of the subscription related to the invoice.
licenses string An array of strings, each representing a license generated for this invoice.
is_instalment boolean Displays whether the invoice payment is collected with an instalment plan.
locale string (Language Code) The default language of the invoice.
start_date timestamp The start date of the billing period associated with this invoice. Provided if the invoice is associated with an active subscription.
end_date timestamp The end date of the billing period associated with this invoice. Provided if the invoice is associated with an active subscription.
affiliate_program string The id of the affiliate program associated with the invoice.
affiliate string The id of the affiliate partner associated with the invoice.
authorization_expiry timestamp A timestamp indicating when the invoice payment authorization will expire. Will be provided if the status of the invoice is authorized and the payment gateway supports it.
payment_charge_date timestamp A timestamp indicating when the invoice payment will be processed. This information is supplied only if the invoice's status is set to 'authorized' and the utilized payment gateway has this capability.
payment_retried boolean Indicating whether a payment has failed and was retried
late_failure boolean Indicating whether a payment has was initially marked as successful but failed later than expected.
customer_information object An object containing the billing and shipping information of the customer associated with this order. All the attributes can be view in the example below.
Whether an attribute is provided depends on the invoice and the items being purchased. For example shipping_information is provided if the order has shipping.
totals object An object containing the totals of the invoice.
- total integer The total amount of the invoice.
- discount integer The total discount that was applied to all the items in the transaction.
- item_count integer The total number of items purchased.
- item_total integer The total cost of all the items after discounts and before taxes.
- item_total_with_tax integer The total cost of all the items after discounts and taxes.
- moss_tax_total integer The total tax that falls under MOSS VAT rules.
- moss_taxable_amount integer The total taxable amount that falls under MOSS VAT rules.
- price_conversion boolean This attribute shows whether prices were converted when calculating this invoice.
- shipping integer The shipping cost after discounts and before taxes.
- shipping_discount integer The shipping discount applied to the invoice.
- shipping_subtotal integer The shipping cost before discounts and taxes.
- shipping_tax integer The shipping tax applied to the invoice.
- shipping_total integer The final shipping cost that the customer is charged. It includes discounts and taxes.
- subtotal integer The total cost of all the items before discounts and taxes.
- tax integer The total tax applied to the invoice.
- trial_deductions integer beta The total amount that was deducted from the total due to subscription trials.
- gateway_fees integer beta The total fees paid to payment processors and Tamio.
- affiliate_revenue integer The commission paid to affiliates.
- amount_due integer The total amount due (not collected).
- amount_cancelled integer The total amount cancelled (will not be collected).
- interest integer beta The total interest charged on the order.
- amount_paid integer The total amount that was paid.
- exchange_rate decimal The exchange rate used for the conversion (if applicable).
merchant object An object containing the merchant's business information at the time the invoice was created.
shipping object An object containing the shipping configuration of the invoice.
- method string The label of the shipping method such as FedEx Express.
- tracking string The tracking number of the shipment.
- shipped boolean This attribute shows whether the order has been shipped.
products array of objects An array of objects containing the products that were purchased.
taxes object An object containing the tax configuration of the invoice.
discounts array of objects An array of objects, each representing a discount that was applied to the invoice.
- id string The id of the discount (if applicable).
- duration integer The number of payments cycles that this discount will be active. Relevant for billing plans.
- discount integer The total discount amount that was applied to all the products in the transaction.
- shipping_discount integer The total shipping discount amount that was applied to all the products in the transaction
- applies_to array of strings An array of product ids that this discount applies to.
- coupon string The coupon that was redeemed for this discount (if applicable).
bank_account object An object contain the bank account details used to complete the payment.
instalment_plan object The instalment plan configuration of the invoice.
- amount_paid integer The total amount paid so far.
- cycle string The billing cycle of the instalment plan. The possible values are month, day, week and year.
- interval integer The billing interval of the instalment plan.
- amount_left integer The total amount left to be paid.
- instalment integer The total number of instalments.
- instalments_amount integer The total amount paid by the customer on each instalment.
- interest integer The total interest in percentage charged in addition to the original invoice price.
- total_amount integer The total amount to be paid by the customer.
- upfront decimal The percentage of the order to be paid upfront.
- upfront_amount integer The total amount to be paid upfront.
- invoices_paid array of objects An array of objects, each representing a invoice that was paid.