Interface CreateSubscriptionCheckoutOptions

Options for AccountApi.createSubscriptionCheckout.

interface CreateSubscriptionCheckoutOptions {
    appSource?: string;
    deviceId?: string;
    redirectType?: SubscriptionRedirectType;
    startTrial?: boolean;
}

Properties

appSource? deviceId? redirectType? startTrial?

Properties

OptionalappSource

appSource?: string

Optional client app/source label stored in Stripe metadata.

OptionaldeviceId

deviceId?: string

Optional opaque host-application context forwarded only when provided.

OptionalredirectType

redirectType?: SubscriptionRedirectType

Post-checkout redirect target. Defaults to 'web'.

OptionalstartTrial

startTrial?: boolean

Whether to start a free trial when the account is eligible. Defaults to the server's behavior when omitted. Pass false to explicitly subscribe now with no trial even if the account is otherwise eligible — the value is sent verbatim so the backend honors the "no trial" intent.

Settings

Member Visibility

On This Page

Properties