@getopenpay/client/models/CheckoutPreferences.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 { CheckoutProcessorsPreferences } from './CheckoutProcessorsPreferences';
import type { SelectedPriceQuantity } from './SelectedPriceQuantity';
import type { FallbackConfigurationInput } from './FallbackConfigurationInput';
/**
 * Preferences for the checkout session.
 * All changes to this object must be backwards-compatible, old objects should still be valid with all new schemas.
 *
 * Note: this object is stored in both PaymentLinks (in string form) and CheckoutSessions
 * @export
 * @interface CheckoutPreferences
 */
export interface CheckoutPreferences {
    /**
     * This object contains a list of price groups that will be used to fall back to if the selected product price quantity fails to be created. Processor preferences here will override the processor preferences in the processor_preferences field.
     * @type {Array<FallbackConfigurationInput>}
     * @memberof CheckoutPreferences
     */
    fallbackCascadePreferences?: Array<FallbackConfigurationInput>;
    /**
     * This object contains a list of price groups that will be used to fall back to if the selected product price quantity fails to be created.
     * @type {Array<Array<SelectedPriceQuantity>>}
     * @memberof CheckoutPreferences
     */
    fallbackCascadeSelectedProductPriceQuantity?: Array<Array<SelectedPriceQuantity>>;
    /**
     *
     * @type {CheckoutProcessorsPreferences}
     * @memberof CheckoutPreferences
     */
    processorPreferences?: CheckoutProcessorsPreferences | null;
}
/**
 * Check if a given object implements the CheckoutPreferences interface.
 */
export declare function instanceOfCheckoutPreferences(value: object): value is CheckoutPreferences;
export declare function CheckoutPreferencesFromJSON(json: any): CheckoutPreferences;
export declare function CheckoutPreferencesFromJSONTyped(json: any, ignoreDiscriminator: boolean): CheckoutPreferences;
export declare function CheckoutPreferencesToJSON(json: any): CheckoutPreferences;
export declare function CheckoutPreferencesToJSONTyped(value?: CheckoutPreferences | null, ignoreDiscriminator?: boolean): any;