@getopenpay/client/models/PaymentLinkExternal.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 { CheckoutPreferencesOutput } from './CheckoutPreferencesOutput';
import type { PaymentLinkLineItemExternal } from './PaymentLinkLineItemExternal';
import type { PaymentLinkProductBundleExternal } from './PaymentLinkProductBundleExternal';
import type { CheckoutMode } from './CheckoutMode';
import type { ObjectName } from './ObjectName';
/**
 *
 * @export
 * @interface PaymentLinkExternal
 */
export interface PaymentLinkExternal {
    /**
     * Unique Identifier of the account.
     * @type {string}
     * @memberof PaymentLinkExternal
     */
    accountId: string;
    /**
     * Name of the account.
     * @type {string}
     * @memberof PaymentLinkExternal
     */
    accountName: string;
    /**
     * Whether a payment link is active or not.
     * @type {boolean}
     * @memberof PaymentLinkExternal
     */
    active: boolean;
    /**
     * Whether to allow customers to remove items from checkout.
     * @type {boolean}
     * @memberof PaymentLinkExternal
     */
    allowRemoveLineItems?: boolean;
    /**
     * [DEPRECATED] If this flag is set to True and there is no customer attached to the payment link, the payment link will always create a new customer, rather than the default behavior of de-duping by email. This field is deprecated and will be removed in a future version. Use checkout settings instead.
     * @type {boolean}
     * @memberof PaymentLinkExternal
     * @deprecated
     */
    alwaysCreateNewCustomer?: boolean;
    /**
     *
     * @type {CheckoutPreferencesOutput}
     * @memberof PaymentLinkExternal
     */
    checkoutPreferences: CheckoutPreferencesOutput | null;
    /**
     *
     * @type {string}
     * @memberof PaymentLinkExternal
     */
    couponId?: string | null;
    /**
     * DateTime at which the object was created, in 'ISO 8601' format.
     * @type {Date}
     * @memberof PaymentLinkExternal
     */
    createdAt: Date;
    /**
     *
     * @type {string}
     * @memberof PaymentLinkExternal
     */
    currency: string | null;
    /**
     *
     * @type {object}
     * @memberof PaymentLinkExternal
     */
    customFields?: object | null;
    /**
     *
     * @type {string}
     * @memberof PaymentLinkExternal
     */
    customerEmail: string | null;
    /**
     *
     * @type {string}
     * @memberof PaymentLinkExternal
     */
    customerId: string | null;
    /**
     * Unique Identifier of the checkout session.
     * @type {string}
     * @memberof PaymentLinkExternal
     */
    id: string;
    /**
     * If true, indicates that this object has been deleted
     * @type {boolean}
     * @memberof PaymentLinkExternal
     */
    isDeleted?: boolean;
    /**
     * The line items purchased by the customers.
     * @type {Array<PaymentLinkLineItemExternal>}
     * @memberof PaymentLinkExternal
     */
    lineItems: Array<PaymentLinkLineItemExternal>;
    /**
     * The mode of the checkout sessions created by this payment link.
     * @type {CheckoutMode}
     * @memberof PaymentLinkExternal
     */
    mode: CheckoutMode;
    /**
     *
     * @type {ObjectName}
     * @memberof PaymentLinkExternal
     */
    object?: ObjectName;
    /**
     * Whether this payment link is pinned to the top of the list.
     * @type {boolean}
     * @memberof PaymentLinkExternal
     */
    pinned?: boolean;
    /**
     * The product bundles purchased by the customers.
     * @type {Array<PaymentLinkProductBundleExternal>}
     * @memberof PaymentLinkExternal
     */
    productBundles: Array<PaymentLinkProductBundleExternal>;
    /**
     * The random secure token associated with the payment link.
     * @type {string}
     * @memberof PaymentLinkExternal
     */
    secureToken: string;
    /**
     *
     * @type {string}
     * @memberof PaymentLinkExternal
     */
    successUrl: string | null;
    /**
     *
     * @type {Date}
     * @memberof PaymentLinkExternal
     */
    trialEnd: Date | null;
    /**
     *
     * @type {boolean}
     * @memberof PaymentLinkExternal
     */
    trialFromPrice: boolean | null;
    /**
     *
     * @type {number}
     * @memberof PaymentLinkExternal
     */
    trialPeriodDays: number | null;
    /**
     * DateTime at which the object was updated, in 'ISO 8601' format.
     * @type {Date}
     * @memberof PaymentLinkExternal
     */
    updatedAt: Date;
    /**
     * The main URL for this payment link.
     * @type {string}
     * @memberof PaymentLinkExternal
     */
    url: string;
}
/**
 * Check if a given object implements the PaymentLinkExternal interface.
 */
export declare function instanceOfPaymentLinkExternal(value: object): value is PaymentLinkExternal;
export declare function PaymentLinkExternalFromJSON(json: any): PaymentLinkExternal;
export declare function PaymentLinkExternalFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaymentLinkExternal;
export declare function PaymentLinkExternalToJSON(json: any): PaymentLinkExternal;
export declare function PaymentLinkExternalToJSONTyped(value?: PaymentLinkExternal | null, ignoreDiscriminator?: boolean): any;