Transactions API
Transaction Object
attributes id string a unique identifier for the transaction object string the value is always transaction payments array of strings appendix docid\ kfbmx4q3dxjtduqf75yx1 the payment methods that are available for use for this transaction currency string appendix docid\ kfbmx4q3dxjtduqf75yx1 the currency of the invoice locale string ( appendix docid\ kfbmx4q3dxjtduqf75yx1 ) 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 { "customer information" { "name" "john", "email" "johndoe1\@example com", "country" "de", "locale" "en", "last name" "doe", "id" "9c91c6eb 9146 4bf5 82da dc73aba59a46", "stripe customer id" "cus mtonj9efexbggq", "billing information" { "id" "56602ee6 b92c 4054 9ab2 a7afe3bcc3cd", "phone" null, "object" "address", "name" "john", "representative" null, "email" "johndoe1\@example com", "address" "super street", "city" "frankfurt", "postcode" "abc123123", "state" null, "country" "de", "locale" "en", "shipping address" false, "ip" null, "is company" true }, "shipping information" { "id" "ad5701b5 5470 44a3 9a56 af458f24f6b3", "phone" "+123456678", "object" "address", "name" "john doe ltd", "representative" null, "email" "johndoe1\@example com", "address" "shipping street", "city" "frankfurt", "postcode" "123456", "state" null, "country" "de", "locale" "sv", "shipping address" true } } } totals object an object containing the totals of the invoice "totals" { "total" 27477, "discount" 1700, "item count" 1, "subtotal" 17000, // before discounts, before taxes "item total" 15300, // after discounts, before taxes "item total with tax" 15300, // after discounts, after taxes "moss tax total" 0, "moss taxable amount" 0, "shipping subtotal" 12300, // before discounts, before taxes "shipping" 11070, // after discounts, before taxes "shipping total" 12177, // after discounts, after taxes "shipping discount" 1230, "shipping tax" 1107, "tax" 0, "price conversion" true, "trial deductions" 0, "gateway fees" 0, "affiliate revenue" 0, "refunded total" 27477, "amount paid" 27477, "amount cancelled" 0, "amount due" 0 } 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 beta the total amount that was deducted from the total due to subscription trials gateway fees integer beta 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 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 "shipping" { "method" "worldwide shipping 10% off", "tracking" "abc123packxz1", "has shipping" true, "shipped" true } 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 "products" \[ { "cancelled" false, "classification" "general", "currency" "eur", "delivered" true, "discount allowed" true, "discounts" \[ { "coupon" null, "discount" 1700, "duration" 2, "id" "2126f3d9 9c2b 4e9e b515 599cf4a86904", "shipping discount" 1230 } ], "ean" null, "has shipping" true, "id" "aaa1c3f5 196a 487f 8834 db7abc5a87e6", "invoice item id" null, "is moss product" false, "is variant" true, "name" "blue silk tuxedox", "pack" null, "quantity" 1, "reservations" \[], "sku" null, "taxes" { "inclusive" false, "shipping tax rates" \[ { "applies to" \[ "aaa1c3f5 196a 487f 8834 db7abc5a87e6" ], "id" "3af0c3e9 f7e2 4469 8ea0 faf1cf6f666a", "inclusive" false, "label" "my tax", "rate amount" false, "rate percent" 10, "tax" 1107, "vat tax" false } ], "tax rates" \[] }, "totals" { "amount cancelled" 0, "amount paid" 27477, "amount refunded" 27477, "discount" 1700, "exchange rate" null, "full price" 0, "item total" 15300, "item total with tax" 15300, "moss tax total" 0, "moss taxable amount" 0, "price conversion" false, "shipping" 11070, "convert from" null, "shipping discount" 1230, "shipping subtotal" 12300, "shipping tax" 1107, "shipping total" 12177, "subtotal" 17000, "tax" 0, "total" 27477, "unit price" 17000 }, "license list" null, "pack" null, "type" "physical product", "variation id" "d844e301 f550 498f 813e 9669b8a4f83c", "variation label" "default title" } ] taxes object an object containing the tax configuration of the invoice "taxes" { "has vat" true, "tax rates" \[ { "applies to" \[ "619b5981 c097 4eb8 890b 5166b30880fd" ], "id" null, "inclusive" false, "jurisdiction" "lu", "label" "tva", "moss" true, "rate amount" null, "rate percent" 17, "tax" 1700, "vat tax" true } ], "shipping tax rates" \[ { "applies to" \[ "aaa1c3f5 196a 487f 8834 db7abc5a87e6" ], "id" "3af0c3e9 f7e2 4469 8ea0 faf1cf6f666a", "inclusive" false, "label" "my tax", "rate amount" false, "rate percent" 10, "tax" 1107, "vat tax" false } ] } discounts array of objects an array of objects, each representing a discount that was applied to the invoice "discounts" \[ { "applies to" \[ "aaa1c3f5 196a 487f 8834 db7abc5a87e6" ], "coupon" null, "discount" 1700, "duration" 2, "id" "2126f3d9 9c2b 4e9e b515 599cf4a86904", "shipping discount" 1230 } ] 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 "shipping" { "has shipping" true, "item count" 4, "shipping rates" \[ { "id" "bb7d96d5 6b43 4b01 9f8c 089b3d37d951", "label" "fedex express", "cost" 1000, "bundling" true, "service code" null } ] } instalments array of objects an array of objects with the instalment plan options available for the order each object can have the following attributes "instalments" \[ { "id" "", "cycle" "month", "interval" 4, "total amount" 10000, "instalment" 4, "instalments amount" 2500, "interest" 0, "upfront" null, "upfront amount" null, "offset" null } ] 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 { "object" "transaction", "affiliate" null, "site" null, "customer information" { "name" "john", "email" "customer\@example com", "country" "dk", "locale" "en", "id" "a38f68fb 23f8 409d 93d4 86386a0e6441", "stripe customer id" "cus mtqtejhzzql9in", "billing information" { "id" "83ce060b 80e3 41d2 87a9 d723e9657a00", "phone" null, "object" "address", "name" "john doe", "representative" null, "email" "customer\@example com", "address" "jane doe street", "city" "copenhagen", "postcode" "abc1234", "state" null, "country" "dk", "locale" "en", "shipping address" false, "ip" null, "is company" false } }, "payments" \[ "stripe", "giropay", "eps", "przelewy24", "ideal", "bancontact", "sepa", "googlepay", "klarna", "paypalindividual", "cash", "instalments" ], "locale" "en", "instalments" \[ { "interval" 1, "instalments" 3, "cycle" "week", "upfront amount" null, "instalments amount" 3 33, "total amount" 10, "interest" 0, "id" "tmp id 0" } ], "taxes" { "tax rates" \[ { "id" null, "rate percent" 25, "rate amount" null, "label" "moms", "tax" 2, "moss" true, "jurisdiction" "dk", "inclusive" true, "vat tax" true, "applies to" \[ "bb7d96d5 6b43 4b01 9f8c 089b3d37d951" ] } ], "shipping tax rates" \[], "has vat" true }, "shipping" { "has shipping" false, "shipping rates" \[], "item count" 0 }, "currency" "eur", "products" \[ { "name" "my awesome digital product", "quantity" 1, "type" "digital product", "classification" "ebooks", "discount allowed" true, "is moss product" true, "currency" "eur", "id" "bb7d96d5 6b43 4b01 9f8c 089b3d37d951", "taxes" { "inclusive" true, "tax rates" \[ { "id" null, "rate percent" 25, "rate amount" null, "label" "moms", "tax" 2, "moss" true, "jurisdiction" "dk", "inclusive" true, "vat tax" true } ], "shipping tax rates" \[] }, "totals" { "unit price" 10, "item total" 10, "total" 10, "discount" 0, "shipping subtotal" 0, "shipping discount" 0, "shipping tax" 0, "shipping" 0, "shipping total" 0, "tax" 2, "subtotal" 10, "exchange rate" null, "price conversion" false, "moss taxable amount" 8, "moss tax total" 2, "item total with tax" 10, "full price" 10 }, "reservations" \[], "discounts" \[], "has shipping" false, "variation id" null, "is variant" false, "pack" null, "ean" null, "sku" null } ], "totals" { "tax" 2, "shipping" 0, "shipping tax" 0, "subtotal" 10, "total" 10, "discount" 0, "item count" 1, "shipping discount" 0, "item total with tax" 10, "shipping subtotal" 0, "price conversion" false, "item total" 10, "moss tax total" 2, "moss taxable amount" 8, "trial deductions" 0, "shipping total" 0 }, "discounts" \[], "id" "2f942812 e572 41c3 a5a8 0e49e32ea960" }