@usethrottle/checkout-react 2.0.0 → 2.1.1

package/dist/index.d.cts

@@ -38,6 +38,8 @@ type ThrottleEvent = {
     paymentId: string;
     paymentStatus?: string;
     subscriptionId?: string;
+    /** v1.5 additive — every subscription the checkout created, in line order. `subscriptionId` is set only when there is exactly one. */
+    subscriptionIds?: string[];
     /** v1.4 additive — order total in minor units, for analytics purchase events. */
     total?: number;
     currency?: string;
@@ -77,7 +79,7 @@ type ThrottleParentMessage = ThrottleParentCommand & ThrottleParentEnvelope;
  * requiring a runtime read of the session.
  *
  * - `create: 'auto'` (default) — server creates the subscription on
- *   vault success. `onSucceeded` payload includes `subscriptionId`.
+ *   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.
@@ -147,6 +149,8 @@ interface ThrottleEmbedProps {
         orderId: string;
         paymentId: string;
         subscriptionId?: string;
+        /** Every subscription the checkout created, in line order. `subscriptionId` is set only when there is exactly one. */
+        subscriptionIds?: string[];
         /** Order total in minor units — fire `gtag`/`fbq` purchase events with value = total / 100. */
         total?: number;
         currency?: string;
@@ -217,9 +221,14 @@ declare function useThrottleEvents({ iframeRef, expectedOrigin, onMessage }: Use
 interface UseCartSessionOptions {
     /** Application UUID. */
     applicationId: string;
-    /** Workspace environment UUID the publishable token was minted for. */
+    /** Workspace environment UUID the quote token was minted for. */
     environmentId: string;
-    /** Publishable storefront quote token (`pk_…`). */
+    /**
+     * Storefront quote token (`qt_…`), from the dashboard Shipping & Tax page or
+     * `POST /api/v1/shipping-tax/quote-tokens`. Tokens minted before `qt_` start
+     * with `pk_` and keep working. A `pk_` publishable API key is a different
+     * credential and is refused (`401 invalid_quote_token`).
+     */
     quoteToken: string;
     baseUrl?: string;
     /**

package/dist/index.d.ts

@@ -38,6 +38,8 @@ type ThrottleEvent = {
     paymentId: string;
     paymentStatus?: string;
     subscriptionId?: string;
+    /** v1.5 additive — every subscription the checkout created, in line order. `subscriptionId` is set only when there is exactly one. */
+    subscriptionIds?: string[];
     /** v1.4 additive — order total in minor units, for analytics purchase events. */
     total?: number;
     currency?: string;
@@ -77,7 +79,7 @@ type ThrottleParentMessage = ThrottleParentCommand & ThrottleParentEnvelope;
  * requiring a runtime read of the session.
  *
  * - `create: 'auto'` (default) — server creates the subscription on
- *   vault success. `onSucceeded` payload includes `subscriptionId`.
+ *   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.
@@ -147,6 +149,8 @@ interface ThrottleEmbedProps {
         orderId: string;
         paymentId: string;
         subscriptionId?: string;
+        /** Every subscription the checkout created, in line order. `subscriptionId` is set only when there is exactly one. */
+        subscriptionIds?: string[];
         /** Order total in minor units — fire `gtag`/`fbq` purchase events with value = total / 100. */
         total?: number;
         currency?: string;
@@ -217,9 +221,14 @@ declare function useThrottleEvents({ iframeRef, expectedOrigin, onMessage }: Use
 interface UseCartSessionOptions {
     /** Application UUID. */
     applicationId: string;
-    /** Workspace environment UUID the publishable token was minted for. */
+    /** Workspace environment UUID the quote token was minted for. */
     environmentId: string;
-    /** Publishable storefront quote token (`pk_…`). */
+    /**
+     * Storefront quote token (`qt_…`), from the dashboard Shipping & Tax page or
+     * `POST /api/v1/shipping-tax/quote-tokens`. Tokens minted before `qt_` start
+     * with `pk_` and keep working. A `pk_` publishable API key is a different
+     * credential and is refused (`401 invalid_quote_token`).
+     */
     quoteToken: string;
     baseUrl?: string;
     /**