@getopenpay/client/models/InlineSubscriptionItemUpdate.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.
 */
/**
 *
 * @export
 * @interface InlineSubscriptionItemUpdate
 */
export interface InlineSubscriptionItemUpdate {
    /**
     *
     * @type {boolean}
     * @memberof InlineSubscriptionItemUpdate
     */
    addAtPeriodEnd?: boolean | null;
    /**
     *
     * @type {object}
     * @memberof InlineSubscriptionItemUpdate
     */
    customFields?: object | null;
    /**
     * A flag that, if set to true, will delete the specified item immediately from subscription. drop_at_end flag cannot be used while using this behaviour
     * @type {boolean}
     * @memberof InlineSubscriptionItemUpdate
     */
    _delete?: boolean;
    /**
     *
     * @type {string}
     * @memberof InlineSubscriptionItemUpdate
     */
    description?: string | null;
    /**
     *
     * @type {boolean}
     * @memberof InlineSubscriptionItemUpdate
     */
    dropAtEnd?: boolean | null;
    /**
     *
     * @type {string}
     * @memberof InlineSubscriptionItemUpdate
     */
    id?: string | null;
    /**
     *
     * @type {string}
     * @memberof InlineSubscriptionItemUpdate
     */
    priceId?: string | null;
    /**
     *
     * @type {number}
     * @memberof InlineSubscriptionItemUpdate
     */
    quantity?: number | null;
    /**
     *
     * @type {Date}
     * @memberof InlineSubscriptionItemUpdate
     */
    startsAt?: Date | null;
}
/**
 * Check if a given object implements the InlineSubscriptionItemUpdate interface.
 */
export declare function instanceOfInlineSubscriptionItemUpdate(value: object): value is InlineSubscriptionItemUpdate;
export declare function InlineSubscriptionItemUpdateFromJSON(json: any): InlineSubscriptionItemUpdate;
export declare function InlineSubscriptionItemUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): InlineSubscriptionItemUpdate;
export declare function InlineSubscriptionItemUpdateToJSON(json: any): InlineSubscriptionItemUpdate;
export declare function InlineSubscriptionItemUpdateToJSONTyped(value?: InlineSubscriptionItemUpdate | null, ignoreDiscriminator?: boolean): any;