expresspayments/types/InvoiceItems.d.ts

ExpressPayments API wrapper

// File generated from our OpenAPI spec

declare module 'expresspayments' {
    namespace ExpressPayments {
        /**
         * Invoice Items represent the component lines of an [invoice](https://docs.epayments.network/api/invoices). An invoice item is added to an
         * invoice by creating or updating it with an `invoice` field, at which point it will be included as
         * [an invoice line item](https://docs.epayments.network/api/invoices/line_item) within
         * [invoice.lines](https://docs.epayments.network/api/invoices/object#invoice_object-lines).
         *
         * Invoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined
         * with a [subscription](https://docs.epayments.network/api/subscriptions). Sometimes you want to add a charge or credit to a customer, but actually charge
         * or credit the customer's card only at the end of a regular billing cycle. This is useful for combining several charges
         * (to minimize per-transaction fees), or for having ExpressPayments tabulate your usage-based billing totals.
         *
         * Related guides: [Integrate with the Invoicing API](https://docs.epayments.network/invoicing/integration), [Subscription Invoices](https://docs.epayments.network/billing/invoices/subscription#adding-upcoming-invoice-items).
         */
        interface InvoiceItem {
            /**
             * Unique identifier for the object.
             */
            id: string;

            /**
             * String representing the object's type. Objects of the same type share the same value.
             */
            object: 'invoiceitem';

            /**
             * Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`.
             */
            amount: number;

            /**
             * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://docs.epayments.network/currencies).
             */
            currency: string;

            /**
             * The ID of the customer who will be billed when this invoice item is billed.
             */
            customer:
                | string
                | ExpressPayments.Customer
                | ExpressPayments.DeletedCustomer;

            /**
             * Time at which the object was created. Measured in seconds since the Unix epoch.
             */
            date: number;

            deleted?: void;

            /**
             * An arbitrary string attached to the object. Often useful for displaying to users.
             */
            description: string | null;

            /**
             * If true, discounts will apply to this invoice item. Always false for prorations.
             */
            discountable: boolean;

            /**
             * The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.
             */
            discounts: Array<string | ExpressPayments.Discount> | null;

            /**
             * The ID of the invoice this invoice item belongs to.
             */
            invoice: string | ExpressPayments.Invoice | null;

            /**
             * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
             */
            livemode: boolean;

            /**
             * Set of [key-value pairs](https://docs.epayments.network/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
             */
            metadata: ExpressPayments.Metadata | null;

            period: InvoiceItem.Period;

            /**
             * If the invoice item is a proration, the plan of the subscription that the proration was computed for.
             */
            plan: ExpressPayments.Plan | null;

            /**
             * The price of the invoice item.
             */
            price: ExpressPayments.Price | null;

            /**
             * Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
             */
            proration: boolean;

            /**
             * Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
             */
            quantity: number;

            /**
             * The subscription that this invoice item has been created for, if any.
             */
            subscription: string | ExpressPayments.Subscription | null;

            /**
             * The subscription item that this invoice item has been created for, if any.
             */
            subscription_item?: string;

            /**
             * The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item.
             */
            tax_rates: Array<ExpressPayments.TaxRate> | null;

            /**
             * ID of the test clock this invoice item belongs to.
             */
            test_clock: string | ExpressPayments.TestHelpers.TestClock | null;

            /**
             * Unit amount (in the `currency` specified) of the invoice item.
             */
            unit_amount: number | null;

            /**
             * Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.
             */
            unit_amount_decimal: string | null;
        }

        namespace InvoiceItem {
            interface Period {
                /**
                 * The end of the period, which must be greater than or equal to the start. This value is inclusive.
                 */
                end: number;

                /**
                 * The start of the period. This value is inclusive.
                 */
                start: number;
            }
        }

        /**
         * The DeletedInvoiceItem object.
         */
        interface DeletedInvoiceItem {
            /**
             * Unique identifier for the object.
             */
            id: string;

            /**
             * String representing the object's type. Objects of the same type share the same value.
             */
            object: 'invoiceitem';

            /**
             * Always true for a deleted object
             */
            deleted: true;
        }
    }
}