stripe/cjs/resources/Tax/TransactionLineItems.d.ts

Stripe API wrapper

import { Metadata } from '../../shared.js';
export interface TransactionLineItem {
    /**
     * Unique identifier for the object.
     */
    id: string;
    /**
     * String representing the object's type. Objects of the same type share the same value.
     */
    object: 'tax.transaction_line_item';
    /**
     * The line item amount in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
     */
    amount: number;
    /**
     * The amount of tax calculated for this line item, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
     */
    amount_tax: number;
    /**
     * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
     */
    livemode: boolean;
    /**
     * Set of [key-value pairs](https://docs.stripe.com/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: Metadata | null;
    /**
     * The ID of an existing [Product](https://docs.stripe.com/api/products/object).
     */
    product: string | null;
    /**
     * The number of units of the item being purchased. For reversals, this is the quantity reversed.
     */
    quantity: number;
    /**
     * A custom identifier for this line item in the transaction.
     */
    reference: string;
    /**
     * If `type=reversal`, contains information about what was reversed.
     */
    reversal: Tax.TransactionLineItem.Reversal | null;
    /**
     * Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.
     */
    tax_behavior: Tax.TransactionLineItem.TaxBehavior;
    /**
     * The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for this resource.
     */
    tax_code: string;
    /**
     * If `reversal`, this line item reverses an earlier transaction.
     */
    type: Tax.TransactionLineItem.Type;
}
export declare namespace Tax {
    namespace TransactionLineItem {
        interface Reversal {
            /**
             * The `id` of the line item to reverse in the original transaction.
             */
            original_line_item: string;
        }
        type TaxBehavior = 'exclusive' | 'inclusive';
        type Type = 'reversal' | 'transaction';
    }
}