@usethrottle/checkout-react
    Preparing search index...

    Interface RecurringIntent

    Recurring subscription intent for an embed-driven subscribe flow.

    The authoritative recurring metadata lives on the checkout session (set when calling POST /api/v1/checkout/sessions). This prop is a type-level hint that signals subscription intent in your TSX without requiring a runtime read of the session.

    • create: 'auto' (default) — server creates the subscription on vault success. onSucceeded payload includes subscriptionIds (and subscriptionId when exactly one was created).
    • create: 'manual' — server only vaults; merchant calls subscriptions.create from their backend after payment.vaulted webhook or onSucceeded callback.
    interface RecurringIntent {
        amount?: number;
        create?: "auto" | "manual";
        interval?:
            | "weekly"
            | "biweekly"
            | "monthly"
            | "quarterly"
            | "yearly"
            | "custom";
        intervalCount?: number;
        intervalUnit?: "hour"
        | "day"
        | "week"
        | "month";
        plan: string;
        planName?: string;
        totalPayments?: number;
        trialDays?: number;
    }
    Index
    amount? create? interval? intervalCount? intervalUnit? plan planName? totalPayments? trialDays?
    amount?: number
    create?: "auto" | "manual"
    interval?: "weekly" | "biweekly" | "monthly" | "quarterly" | "yearly" | "custom"

    A named interval. Or send intervalUnit + intervalCount for any cadence from 1 hour to 1 year.

    intervalCount?: number
    intervalUnit?: "hour" | "day" | "week" | "month"
    plan: string
    planName?: string
    totalPayments?: number

    Makes the subscription an installment plan of exactly this many payments (2–60). Not combinable with trialDays.

    trialDays?: number

    Settings
    Member Visibility

    On This Page
    Properties