Overview

On this page, we’ll dive into the different invoice endpoints you can use to manage invoices programmatically.

Invoices are orders placed by customers. They contain all the info you might need for each order, from the total purchase amount, customer information, and the product(s) delivered.

On this page, we'll dive into the different invoice endpoints you can use to manage invoices programmatically. We'll look at how to view, create, and update invoices.

Endpoints

The invoice model

The invoice model contains all the information about the invoices stores have, including the type, code, and discount amount.

Properties

Name: idinteger
Description: The unique identifier for the invoice.
Name: paymentarray
Description: The array of general payment details. Consists of the following parts:

fee Displays the platform fee associated with this invoice.

gateway Contains payment gateway type, transaction ID, checkout URL, and payment-method-specific metadata such as crypto addresses and requested / received crypto amounts.

subtotal Payment subtotal calculation, contains currency, VAT, and total.

expires_at At which time the invoice expires and no longer becomes payable.

full_price Shows the full price of the invoice and includes modifiers such as extra amounts (Pay What You Want).

original_amount Displays the original amount of the invoice and excludes modifiers such as extra amounts (Pay What You Want).
Name: statusarray
Description: The historical array of the invoice's status. Consists of two parts:

history Array of historical order statuses.

status Current order status details.
Name: webhooksarray
Description: The webhook details, if set.
Name: feedbackstring
Description: The customer order feedback, if made.
Name: created_attimestamp
Description: The time at which this invoice was first created.
Name: updated_attimestamp
Description: The time at which this invoice was last updated.
Name: store_idinteger
Description: The ID of the store this invoice belongs to.
Name: coupon_idinteger
Description: The ID of the coupon applied to this order, if set.
Name: subscription_idinteger
Description: The ID of the subscription belonging to the invoice, if set.
Name: customer_informationarray
Description: The associated customer's information, consists of:

id SellApp user ID (if logged in).

email Customer email.

country Customer country.

location Customer location (city level).

ip Customer IP.

proxied Boolean; whether the customer is using IP obfuscation software or not.

browser_agent Browser agent used to make the purchase.

vat Array of VAT details, consists of amount in cents and country as country code.