Type Alias ThrottleEvent

Type Declaration

• { type: "throttle.ready" }
• { height: number; type: "throttle.resize" }
• { type: "throttle.processing" }
• {
      currency?: string;
      lineItems?: ThrottleCompletedLineItem[];
      orderId: string;
      paymentId: string;
      paymentStatus?: string;
      subscriptionId?: string;
      subscriptionIds?: string[];
      total?: number;
      type: "throttle.completed";
  }

  • Optionalcurrency?: string

  • OptionallineItems?: ThrottleCompletedLineItem[]

  • orderId: string

  • paymentId: string

  • OptionalpaymentStatus?: string

  • 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";
  }