@getopenpay/client/models/CreateCheckoutSessionRequest.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 { CreateCheckoutLineItem } from './CreateCheckoutLineItem';
import type { CheckoutPreferences } from './CheckoutPreferences';
import type { CurrencyEnum } from './CurrencyEnum';
import type { CustomerLanguage } from './CustomerLanguage';
import type { CheckoutMode } from './CheckoutMode';
/**
 *
 * @export
 * @interface CreateCheckoutSessionRequest
 */
export interface CreateCheckoutSessionRequest {
    /**
     *
     * @type {CheckoutPreferences}
     * @memberof CreateCheckoutSessionRequest
     */
    checkoutPreferences?: CheckoutPreferences | null;
    /**
     *
     * @type {string}
     * @memberof CreateCheckoutSessionRequest
     */
    clientReferenceId?: string | null;
    /**
     *
     * @type {string}
     * @memberof CreateCheckoutSessionRequest
     */
    couponId?: string | null;
    /**
     *
     * @type {CurrencyEnum}
     * @memberof CreateCheckoutSessionRequest
     */
    currency?: CurrencyEnum | null;
    /**
     *
     * @type {object}
     * @memberof CreateCheckoutSessionRequest
     */
    customFields?: object | null;
    /**
     *
     * @type {string}
     * @memberof CreateCheckoutSessionRequest
     */
    customerEmail?: string | null;
    /**
     *
     * @type {string}
     * @memberof CreateCheckoutSessionRequest
     */
    customerId?: string | null;
    /**
     *
     * @type {CustomerLanguage}
     * @memberof CreateCheckoutSessionRequest
     */
    language?: CustomerLanguage | null;
    /**
     * The line items purchased by the customer. (Deprecated - use bundle_ids instead)
     * @type {Array<CreateCheckoutLineItem>}
     * @memberof CreateCheckoutSessionRequest
     */
    lineItems?: Array<CreateCheckoutLineItem>;
    /**
     * The mode of the Checkout Session. Possible values: payment (one-time payments), setup (collect payment info), subscription (recurring payments).
     * @type {CheckoutMode}
     * @memberof CreateCheckoutSessionRequest
     */
    mode: CheckoutMode;
    /**
     * List of product bundle IDs to include in this checkout session. The first product bundle will be selected by default.
     * @type {Array<string>}
     * @memberof CreateCheckoutSessionRequest
     */
    productBundleIds?: Array<string>;
    /**
     *
     * @type {string}
     * @memberof CreateCheckoutSessionRequest
     */
    returnUrl?: string | null;
    /**
     *
     * @type {string}
     * @memberof CreateCheckoutSessionRequest
     */
    selectedProductBundleId?: string | null;
    /**
     *
     * @type {string}
     * @memberof CreateCheckoutSessionRequest
     */
    successUrl?: string | null;
    /**
     *
     * @type {Date}
     * @memberof CreateCheckoutSessionRequest
     */
    trialEnd?: Date | null;
    /**
     *
     * @type {boolean}
     * @memberof CreateCheckoutSessionRequest
     */
    trialFromPrice?: boolean | null;
    /**
     *
     * @type {number}
     * @memberof CreateCheckoutSessionRequest
     */
    trialPeriodDays?: number | null;
}
/**
 * Check if a given object implements the CreateCheckoutSessionRequest interface.
 */
export declare function instanceOfCreateCheckoutSessionRequest(value: object): value is CreateCheckoutSessionRequest;
export declare function CreateCheckoutSessionRequestFromJSON(json: any): CreateCheckoutSessionRequest;
export declare function CreateCheckoutSessionRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateCheckoutSessionRequest;
export declare function CreateCheckoutSessionRequestToJSON(json: any): CreateCheckoutSessionRequest;
export declare function CreateCheckoutSessionRequestToJSONTyped(value?: CreateCheckoutSessionRequest | null, ignoreDiscriminator?: boolean): any;