@getopenpay/client/models/InvoiceItemPublic.d.ts

OpenPay API TypeScript SDK

/**
 * OpenPay API
 * super charge your subscription management.
 *
 * The version of the OpenAPI document: 1.2.1
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { InvoiceItemDiscountAmountsPublic } from './InvoiceItemDiscountAmountsPublic';
import type { CurrencyEnum } from './CurrencyEnum';
import type { PriceTierPublic } from './PriceTierPublic';
/**
 *
 * @export
 * @interface InvoiceItemPublic
 */
export interface InvoiceItemPublic {
    /**
     * Total amount of invoice_item in atomic units (in USD this is cents).
     * @type {number}
     * @memberof InvoiceItemPublic
     */
    amountAtom: number;
    /**
     * Total amount of invoice_item in atomic units considering discounts
     * @type {number}
     * @memberof InvoiceItemPublic
     */
    amountAtomConsideringDiscountApplied: number;
    /**
     * Three-letter ISO currency code, in lowercase.
     * @type {CurrencyEnum}
     * @memberof InvoiceItemPublic
     */
    currency: CurrencyEnum;
    /**
     * The amount_atom of all discount.
     * @type {Array<InvoiceItemDiscountAmountsPublic>}
     * @memberof InvoiceItemPublic
     */
    discountAmountAtoms: Array<InvoiceItemDiscountAmountsPublic>;
    /**
     * The discounts only directly applied to the InvoiceItem.
     * @type {Array<string>}
     * @memberof InvoiceItemPublic
     */
    discounts: Array<string>;
    /**
     *
     * @type {string}
     * @memberof InvoiceItemPublic
     */
    invoiceItemDescription: string | null;
    /**
     * The name of the line item as it appears in the invoice.
     * @type {string}
     * @memberof InvoiceItemPublic
     */
    name: string;
    /**
     * End of the usage period of the invoice_item. It is in 'ISO 8601' format.
     * @type {Date}
     * @memberof InvoiceItemPublic
     */
    periodEnd: Date;
    /**
     * The price tiers of the product, if applicable.
     * @type {Array<PriceTierPublic>}
     * @memberof InvoiceItemPublic
     */
    priceTiers?: Array<PriceTierPublic>;
    /**
     * Quantity of the line item.
     * @type {number}
     * @memberof InvoiceItemPublic
     */
    quantity: number;
    /**
     *
     * @type {string}
     * @memberof InvoiceItemPublic
     */
    subscriptionItemDescription?: string | null;
}
/**
 * Check if a given object implements the InvoiceItemPublic interface.
 */
export declare function instanceOfInvoiceItemPublic(value: object): value is InvoiceItemPublic;
export declare function InvoiceItemPublicFromJSON(json: any): InvoiceItemPublic;
export declare function InvoiceItemPublicFromJSONTyped(json: any, ignoreDiscriminator: boolean): InvoiceItemPublic;
export declare function InvoiceItemPublicToJSON(json: any): InvoiceItemPublic;
export declare function InvoiceItemPublicToJSONTyped(value?: InvoiceItemPublic | null, ignoreDiscriminator?: boolean): any;