@getopenpay/client/models/UpdateSubscriptionRequest.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 { CollectionMethodEnum } from './CollectionMethodEnum';
import type { ProrationEnum } from './ProrationEnum';
import type { InlineSubscriptionItemUpdate } from './InlineSubscriptionItemUpdate';
/**
 *
 * @export
 * @interface UpdateSubscriptionRequest
 */
export interface UpdateSubscriptionRequest {
    /**
     *
     * @type {boolean}
     * @memberof UpdateSubscriptionRequest
     */
    cancelAtEnd?: boolean | null;
    /**
     *
     * @type {CollectionMethodEnum}
     * @memberof UpdateSubscriptionRequest
     */
    collectionMethod?: CollectionMethodEnum | null;
    /**
     *
     * @type {string}
     * @memberof UpdateSubscriptionRequest
     */
    couponId?: string | null;
    /**
     *
     * @type {object}
     * @memberof UpdateSubscriptionRequest
     */
    customFields?: object | null;
    /**
     *
     * @type {string}
     * @memberof UpdateSubscriptionRequest
     */
    description?: string | null;
    /**
     * Whether the request is in preview mode (subscriptions won't actually be updated)
     * @type {boolean}
     * @memberof UpdateSubscriptionRequest
     */
    isPreview?: boolean;
    /**
     * A list of up to 20 subscription items, each with an attached price.
     * @type {Array<InlineSubscriptionItemUpdate>}
     * @memberof UpdateSubscriptionRequest
     */
    items?: Array<InlineSubscriptionItemUpdate>;
    /**
     *
     * @type {number}
     * @memberof UpdateSubscriptionRequest
     */
    netD?: number | null;
    /**
     *
     * @type {Date}
     * @memberof UpdateSubscriptionRequest
     */
    newPeriodEnd?: Date | null;
    /**
     *
     * @type {string}
     * @memberof UpdateSubscriptionRequest
     */
    paymentMethodId?: string | null;
    /**
     * Whether to include the preview of the renewal invoices for the subscriptions in the response.
     * @type {boolean}
     * @memberof UpdateSubscriptionRequest
     */
    previewRenewalInvoices?: boolean;
    /**
     *
     * @type {string}
     * @memberof UpdateSubscriptionRequest
     */
    promotionCode?: string | null;
    /**
     * Determines how to handle prorations when the billable items changes
     * @type {ProrationEnum}
     * @memberof UpdateSubscriptionRequest
     */
    prorationBehavior?: ProrationEnum;
    /**
     *
     * @type {Date}
     * @memberof UpdateSubscriptionRequest
     */
    trialEnd?: Date | null;
    /**
     *
     * @type {number}
     * @memberof UpdateSubscriptionRequest
     */
    trialPeriodDays?: number | null;
}
/**
 * Check if a given object implements the UpdateSubscriptionRequest interface.
 */
export declare function instanceOfUpdateSubscriptionRequest(value: object): value is UpdateSubscriptionRequest;
export declare function UpdateSubscriptionRequestFromJSON(json: any): UpdateSubscriptionRequest;
export declare function UpdateSubscriptionRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateSubscriptionRequest;
export declare function UpdateSubscriptionRequestToJSON(json: any): UpdateSubscriptionRequest;
export declare function UpdateSubscriptionRequestToJSONTyped(value?: UpdateSubscriptionRequest | null, ignoreDiscriminator?: boolean): any;