@getopenpay/client/models/ProductBundleItemExternal.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 { CalendarIntervalEnum } from './CalendarIntervalEnum';
import type { ObjectName } from './ObjectName';
/**
 *
 * @export
 * @interface ProductBundleItemExternal
 */
export interface ProductBundleItemExternal {
    /**
     * Subtotal amount for this bundle item.
     * @type {number}
     * @memberof ProductBundleItemExternal
     */
    amountSubtotalAtom: number;
    /**
     * Total amount for this bundle item.
     * @type {number}
     * @memberof ProductBundleItemExternal
     */
    amountTotalAtom: number;
    /**
     *
     * @type {CalendarIntervalEnum}
     * @memberof ProductBundleItemExternal
     */
    billingInterval: CalendarIntervalEnum | null;
    /**
     *
     * @type {number}
     * @memberof ProductBundleItemExternal
     */
    billingIntervalCount: number | null;
    /**
     * DateTime at which the object was created, in 'ISO 8601' format.
     * @type {Date}
     * @memberof ProductBundleItemExternal
     */
    createdAt: Date;
    /**
     * Currency of this bundle item.
     * @type {string}
     * @memberof ProductBundleItemExternal
     */
    currency: string;
    /**
     *
     * @type {object}
     * @memberof ProductBundleItemExternal
     */
    customFields: object | null;
    /**
     *
     * @type {string}
     * @memberof ProductBundleItemExternal
     */
    description?: string | null;
    /**
     * Unique Identifier of the bundle item.
     * @type {string}
     * @memberof ProductBundleItemExternal
     */
    id: string;
    /**
     * Whether this is the default price for the product in this bundle.
     * @type {boolean}
     * @memberof ProductBundleItemExternal
     */
    isDefault?: boolean;
    /**
     * If true, indicates that this object has been deleted
     * @type {boolean}
     * @memberof ProductBundleItemExternal
     */
    isDeleted?: boolean;
    /**
     *
     * @type {ObjectName}
     * @memberof ProductBundleItemExternal
     */
    object?: ObjectName;
    /**
     * ID of the default price.
     * @type {string}
     * @memberof ProductBundleItemExternal
     */
    priceId: string;
    /**
     * ID of the product bundle.
     * @type {string}
     * @memberof ProductBundleItemExternal
     */
    productBundleId: string;
    /**
     * ID of the product.
     * @type {string}
     * @memberof ProductBundleItemExternal
     */
    productId: string;
    /**
     * Quantity of this item in the bundle.
     * @type {number}
     * @memberof ProductBundleItemExternal
     */
    quantity: number;
    /**
     * DateTime at which the object was updated, in 'ISO 8601' format.
     * @type {Date}
     * @memberof ProductBundleItemExternal
     */
    updatedAt: Date;
}
/**
 * Check if a given object implements the ProductBundleItemExternal interface.
 */
export declare function instanceOfProductBundleItemExternal(value: object): value is ProductBundleItemExternal;
export declare function ProductBundleItemExternalFromJSON(json: any): ProductBundleItemExternal;
export declare function ProductBundleItemExternalFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProductBundleItemExternal;
export declare function ProductBundleItemExternalToJSON(json: any): ProductBundleItemExternal;
export declare function ProductBundleItemExternalToJSONTyped(value?: ProductBundleItemExternal | null, ignoreDiscriminator?: boolean): any;