Transaction Object
id string A unique identifier for the transaction.
object string The value is always transaction.
payments array of strings payment codes The payment methods that are available for use for this transaction.
currency string Currency code The currency of the invoice.
locale string (Language code) The language of the transaction.
affiliate string The id of the affiliate associated with this transaction.
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 any prices were converted when calculating this invoice. Prices might refer to product cost, shipping cost, discount amount etc.
- 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.
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).
shipping object An object containing the shipping configuration of the transaction.
instalments array of objects An array of objects with the instalment plan options available for the order. Each object can have the following attributes.
- id string The id of the instalment plan. Use this ID when finalising a transaction to specify which plan to use during the payment processing.
- 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.
- total_amount integer The total amount to be paid by the customer.
- instalment integer The total number of instalments.
- instalments_amount integer The total amount paid by the customer on each instalment.
- interest decimal 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.
- offset integer The amount that was offset from the total in order to generate the instalment plan.