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

    Type Alias ThrottleEvent

    ThrottleEvent:
        | { type: "throttle.ready" }
        | { height: number; type: "throttle.resize" }
        | {
            ecommerce?: ThrottleWireEcommerce;
            serverSideGa4?: boolean;
            type: "throttle.processing";
        }
        | { ecommerce: ThrottleWireEcommerce; type: "throttle.shipping.submitted" }
        | {
            data: Record<string, unknown>;
            name: string;
            type: "throttle.scriptEvent";
        }
        | { context: money; type: "throttle.analyticsContext" }
        | {
            adPersonalization?: boolean;
            adUserData?: boolean;
            analytics?: boolean;
            marketing?: boolean;
            type: "throttle.consent";
        }
        | {
            currency?: money;
            ecommerce?: ThrottleWireEcommerce;
            lineItems?: ThrottleCompletedLineItem[];
            orderId: string;
            paymentId: string;
            paymentStatus?: string;
            serverSideGa4?: boolean;
            subscriptionId?: string;
            subscriptionIds?: string[];
            total?: number;
            type: "throttle.completed";
        }
        | { type: "throttle.cancelled" }
        | { code: string; message: string; type: "throttle.error" }
        | {
            step: "cart" | "address" | "shipping" | "billing" | "payment";
            type: "throttle.step.changed";
        }

    Type Declaration

    • { type: "throttle.ready" }
    • { height: number; type: "throttle.resize" }
    • {
          ecommerce?: ThrottleWireEcommerce;
          serverSideGa4?: boolean;
          type: "throttle.processing";
      }
    • { ecommerce: ThrottleWireEcommerce; type: "throttle.shipping.submitted" }
    • { data: Record<string, unknown>; name: string; type: "throttle.scriptEvent" }

      A checkout funnel event forwarded out of the iframe (checkout.started, checkout.shipping_submitted, checkout.payment_submitted, checkout.completed). Feeds onAnalyticsEvent.

    • { context: money; type: "throttle.analyticsContext" }
    • {
          adPersonalization?: boolean;
          adUserData?: boolean;
          analytics?: boolean;
          marketing?: boolean;
          type: "throttle.consent";
      }
    • {
          currency?: money;
          ecommerce?: ThrottleWireEcommerce;
          lineItems?: ThrottleCompletedLineItem[];
          orderId: string;
          paymentId: string;
          paymentStatus?: string;
          serverSideGa4?: boolean;
          subscriptionId?: string;
          subscriptionIds?: string[];
          total?: number;
          type: "throttle.completed";
      }
      • Optionalcurrency?: money
      • Optionalecommerce?: ThrottleWireEcommerce

        v1.7 additive — GA4 purchase payload. serverSideGa4 true means the server sends the purchase.

      • OptionallineItems?: ThrottleCompletedLineItem[]
      • orderId: string
      • paymentId: string
      • OptionalpaymentStatus?: string
      • OptionalserverSideGa4?: boolean
      • OptionalsubscriptionId?: string
      • OptionalsubscriptionIds?: string[]

        v1.5 additive — every subscription the checkout created, in line order. subscriptionId is set only when there is exactly one.

      • Optionaltotal?: number

        v1.4 additive — order total in minor units, for analytics purchase events.

      • type: "throttle.completed"
    • { type: "throttle.cancelled" }
    • { code: string; message: string; type: "throttle.error" }
    • {
          step: "cart" | "address" | "shipping" | "billing" | "payment";
          type: "throttle.step.changed";
      }