@getopenpay/client/models/SubscriptionItemExternal.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 { PriceExternal } from './PriceExternal';
import type { CurrencyEnum } from './CurrencyEnum';
import type { ObjectName } from './ObjectName';
/**
 *
 * @export
 * @interface SubscriptionItemExternal
 */
export interface SubscriptionItemExternal {
    /**
     * Whether or not this item will be added before next renewal
     * @type {boolean}
     * @memberof SubscriptionItemExternal
     */
    addAtPeriodEnd: boolean;
    /**
     * DateTime at which the object was created, in 'ISO 8601' format.
     * @type {Date}
     * @memberof SubscriptionItemExternal
     */
    createdAt: Date;
    /**
     * Three-letter ISO currency code, in lowercase.
     * @type {CurrencyEnum}
     * @memberof SubscriptionItemExternal
     */
    currency: CurrencyEnum;
    /**
     *
     * @type {object}
     * @memberof SubscriptionItemExternal
     */
    customFields?: object | null;
    /**
     *
     * @type {Date}
     * @memberof SubscriptionItemExternal
     */
    deletedAt: Date | null;
    /**
     *
     * @type {string}
     * @memberof SubscriptionItemExternal
     */
    description?: string | null;
    /**
     * Whether or not this item will be dropped from subscription before next renewal
     * @type {boolean}
     * @memberof SubscriptionItemExternal
     */
    dropAtEnd: boolean;
    /**
     * Unique Identifier of the subscription_item.
     * @type {string}
     * @memberof SubscriptionItemExternal
     */
    id: string;
    /**
     * If true, indicates that this object has been deleted
     * @type {boolean}
     * @memberof SubscriptionItemExternal
     */
    isDeleted?: boolean;
    /**
     *
     * @type {ObjectName}
     * @memberof SubscriptionItemExternal
     */
    object?: ObjectName;
    /**
     *
     * @type {string}
     * @memberof SubscriptionItemExternal
     */
    pendingAttachmentToSubscriptionId?: string | null;
    /**
     * Price object associated with subscription_item
     * @type {PriceExternal}
     * @memberof SubscriptionItemExternal
     */
    price: PriceExternal;
    /**
     * Unique Identifier of the price.
     * @type {string}
     * @memberof SubscriptionItemExternal
     */
    priceId: string;
    /**
     * Unique Identifier of the product.
     * @type {string}
     * @memberof SubscriptionItemExternal
     */
    productId: string;
    /**
     * Quantity of the product selected for the subscription_item.
     * @type {number}
     * @memberof SubscriptionItemExternal
     */
    quantity: number;
    /**
     *
     * @type {string}
     * @memberof SubscriptionItemExternal
     */
    subscriptionId?: string | null;
    /**
     * DateTime at which the object was updated, in 'ISO 8601' format.
     * @type {Date}
     * @memberof SubscriptionItemExternal
     */
    updatedAt: Date;
}
/**
 * Check if a given object implements the SubscriptionItemExternal interface.
 */
export declare function instanceOfSubscriptionItemExternal(value: object): value is SubscriptionItemExternal;
export declare function SubscriptionItemExternalFromJSON(json: any): SubscriptionItemExternal;
export declare function SubscriptionItemExternalFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubscriptionItemExternal;
export declare function SubscriptionItemExternalToJSON(json: any): SubscriptionItemExternal;
export declare function SubscriptionItemExternalToJSONTyped(value?: SubscriptionItemExternal | null, ignoreDiscriminator?: boolean): any;