@waffo/pancake-ts 0.19.1 → 0.21.0

package/dist/index.d.cts

@@ -353,6 +353,10 @@ interface NotificationSettings {
     emailTrialStarted: boolean;
     emailTrialEnding: boolean;
     emailUpcomingCharge: boolean;
+    /** One toggle for all three plan-change customer emails (scheduled / failed / applied) */
+    emailSubscriptionPlanChanged: boolean;
+    /** Customer email sent when a refund on their payment completes */
+    emailRefundSucceeded: boolean;
     notifyNewOrders: boolean;
     notifyNewSubscriptions: boolean;
     notifySubscriptionCanceled: boolean;
@@ -360,18 +364,25 @@ interface NotificationSettings {
     notifySubscriptionPastDue: boolean;
     notifySubscriptionRenewed: boolean;
     notifySubscriptionUncanceled: boolean;
-    notifySubscriptionUpdated: boolean;
+    notifySubscriptionPlanChanged: boolean;
     notifyChargeback: boolean;
+    /** Merchant notification sent when a refund on a payment completes */
+    notifyRefundSucceeded: boolean;
 }
 /**
  * Merchant-writable subset of {@link NotificationSettings}.
  *
- * Consumer-email toggles (`email*`) are managed by the PANCAKE platform and **not**
- * writable from this SDK; they would be silently dropped by the `update-store`
- * endpoint if included. Payout result notifications are platform-managed and always
- * delivered — they have no toggle key. Use this type for any merchant-side update.
+ * Every `notify*` toggle, plus `emailUpcomingCharge` — the renewal reminder is the
+ * one consumer email a merchant may switch off, and switching it off silences it
+ * for every billing period in that store, yearly plans included.
+ *
+ * Every other consumer-email toggle (`email*`) is managed by the PANCAKE
+ * platform and **not** writable from this SDK; the `update-store` endpoint silently
+ * drops them and names them in the response's `warnings`. Payout result
+ * notifications are platform-managed and always delivered — they have no toggle
+ * key. Use this type for any merchant-side update.
  */
-type MerchantWritableNotificationSettings = Pick<NotificationSettings, "notifyNewOrders" | "notifyNewSubscriptions" | "notifySubscriptionCanceled" | "notifySubscriptionEnded" | "notifySubscriptionPastDue" | "notifySubscriptionRenewed" | "notifySubscriptionUncanceled" | "notifySubscriptionUpdated" | "notifyChargeback">;
+type MerchantWritableNotificationSettings = Pick<NotificationSettings, "notifyNewOrders" | "notifyNewSubscriptions" | "notifySubscriptionCanceled" | "notifySubscriptionEnded" | "notifySubscriptionPastDue" | "notifySubscriptionRenewed" | "notifySubscriptionUncanceled" | "notifySubscriptionPlanChanged" | "notifyChargeback" | "notifyRefundSucceeded" | "emailUpcomingCharge">;
 /**
  * Single-theme checkout page styling.
  * @see docs/api-reference/endpoints/stores/overview.mdx
@@ -1034,14 +1045,22 @@ declare enum WebhookEventType {
     OrderCompleted = "order.completed",
     /** Subscription first payment succeeded (newly activated) */
     SubscriptionActivated = "subscription.activated",
-    /** Subscription renewal payment succeeded */
+    /** Subscription payment succeeded — a pure payment event, carries no subscription period or status */
     SubscriptionPaymentSucceeded = "subscription.payment_succeeded",
+    /** Current billing period rolled forward (renewal) */
+    SubscriptionRenewed = "subscription.renewed",
+    /** Subscription recovered from past due (a retried charge succeeded) */
+    SubscriptionRecovered = "subscription.recovered",
+    /** Plan change took effect (upgrade/downgrade) */
+    SubscriptionPlanChanged = "subscription.plan_changed",
+    /** Plan change confirmed, takes effect next billing period */
+    SubscriptionPlanChangeScheduled = "subscription.plan_change_scheduled",
+    /** Plan change did not complete, the current plan stays in effect */
+    SubscriptionPlanChangeFailed = "subscription.plan_change_failed",
     /** Customer initiated cancellation (expires at end of current period) */
     SubscriptionCanceling = "subscription.canceling",
     /** Customer withdrew cancellation (subscription restored) */
     SubscriptionUncanceled = "subscription.uncanceled",
-    /** Subscription product changed (upgrade/downgrade) */
-    SubscriptionUpdated = "subscription.updated",
     /** Subscription fully terminated */
     SubscriptionCanceled = "subscription.canceled",
     /** Renewal payment failed (past due) */
@@ -1057,7 +1076,12 @@ declare enum WebhookEventType {
  */
 interface WebhookEventData {
     orderId: string;
-    /** Order status (e.g., "completed", "active", "canceling") */
+    /**
+     * Order status (e.g., "completed", "active", "canceling").
+     *
+     * Absent on `subscription.payment_succeeded` — that event describes one charge only.
+     * Read the subscription's status from the subscription events instead.
+     */
     orderStatus?: string;
     buyerEmail: string;
     /** Merchant-provided customer identity from checkout session */

package/dist/index.d.ts

@@ -353,6 +353,10 @@ interface NotificationSettings {
     emailTrialStarted: boolean;
     emailTrialEnding: boolean;
     emailUpcomingCharge: boolean;
+    /** One toggle for all three plan-change customer emails (scheduled / failed / applied) */
+    emailSubscriptionPlanChanged: boolean;
+    /** Customer email sent when a refund on their payment completes */
+    emailRefundSucceeded: boolean;
     notifyNewOrders: boolean;
     notifyNewSubscriptions: boolean;
     notifySubscriptionCanceled: boolean;
@@ -360,18 +364,25 @@ interface NotificationSettings {
     notifySubscriptionPastDue: boolean;
     notifySubscriptionRenewed: boolean;
     notifySubscriptionUncanceled: boolean;
-    notifySubscriptionUpdated: boolean;
+    notifySubscriptionPlanChanged: boolean;
     notifyChargeback: boolean;
+    /** Merchant notification sent when a refund on a payment completes */
+    notifyRefundSucceeded: boolean;
 }
 /**
  * Merchant-writable subset of {@link NotificationSettings}.
  *
- * Consumer-email toggles (`email*`) are managed by the PANCAKE platform and **not**
- * writable from this SDK; they would be silently dropped by the `update-store`
- * endpoint if included. Payout result notifications are platform-managed and always
- * delivered — they have no toggle key. Use this type for any merchant-side update.
+ * Every `notify*` toggle, plus `emailUpcomingCharge` — the renewal reminder is the
+ * one consumer email a merchant may switch off, and switching it off silences it
+ * for every billing period in that store, yearly plans included.
+ *
+ * Every other consumer-email toggle (`email*`) is managed by the PANCAKE
+ * platform and **not** writable from this SDK; the `update-store` endpoint silently
+ * drops them and names them in the response's `warnings`. Payout result
+ * notifications are platform-managed and always delivered — they have no toggle
+ * key. Use this type for any merchant-side update.
  */
-type MerchantWritableNotificationSettings = Pick<NotificationSettings, "notifyNewOrders" | "notifyNewSubscriptions" | "notifySubscriptionCanceled" | "notifySubscriptionEnded" | "notifySubscriptionPastDue" | "notifySubscriptionRenewed" | "notifySubscriptionUncanceled" | "notifySubscriptionUpdated" | "notifyChargeback">;
+type MerchantWritableNotificationSettings = Pick<NotificationSettings, "notifyNewOrders" | "notifyNewSubscriptions" | "notifySubscriptionCanceled" | "notifySubscriptionEnded" | "notifySubscriptionPastDue" | "notifySubscriptionRenewed" | "notifySubscriptionUncanceled" | "notifySubscriptionPlanChanged" | "notifyChargeback" | "notifyRefundSucceeded" | "emailUpcomingCharge">;
 /**
  * Single-theme checkout page styling.
  * @see docs/api-reference/endpoints/stores/overview.mdx
@@ -1034,14 +1045,22 @@ declare enum WebhookEventType {
     OrderCompleted = "order.completed",
     /** Subscription first payment succeeded (newly activated) */
     SubscriptionActivated = "subscription.activated",
-    /** Subscription renewal payment succeeded */
+    /** Subscription payment succeeded — a pure payment event, carries no subscription period or status */
     SubscriptionPaymentSucceeded = "subscription.payment_succeeded",
+    /** Current billing period rolled forward (renewal) */
+    SubscriptionRenewed = "subscription.renewed",
+    /** Subscription recovered from past due (a retried charge succeeded) */
+    SubscriptionRecovered = "subscription.recovered",
+    /** Plan change took effect (upgrade/downgrade) */
+    SubscriptionPlanChanged = "subscription.plan_changed",
+    /** Plan change confirmed, takes effect next billing period */
+    SubscriptionPlanChangeScheduled = "subscription.plan_change_scheduled",
+    /** Plan change did not complete, the current plan stays in effect */
+    SubscriptionPlanChangeFailed = "subscription.plan_change_failed",
     /** Customer initiated cancellation (expires at end of current period) */
     SubscriptionCanceling = "subscription.canceling",
     /** Customer withdrew cancellation (subscription restored) */
     SubscriptionUncanceled = "subscription.uncanceled",
-    /** Subscription product changed (upgrade/downgrade) */
-    SubscriptionUpdated = "subscription.updated",
     /** Subscription fully terminated */
     SubscriptionCanceled = "subscription.canceled",
     /** Renewal payment failed (past due) */
@@ -1057,7 +1076,12 @@ declare enum WebhookEventType {
  */
 interface WebhookEventData {
     orderId: string;
-    /** Order status (e.g., "completed", "active", "canceling") */
+    /**
+     * Order status (e.g., "completed", "active", "canceling").
+     *
+     * Absent on `subscription.payment_succeeded` — that event describes one charge only.
+     * Read the subscription's status from the subscription events instead.
+     */
     orderStatus?: string;
     buyerEmail: string;
     /** Merchant-provided customer identity from checkout session */

package/dist/index.js

@@ -1517,9 +1517,13 @@ var WebhookEventType = /* @__PURE__ */ ((WebhookEventType2) => {
   WebhookEventType2["OrderCompleted"] = "order.completed";
   WebhookEventType2["SubscriptionActivated"] = "subscription.activated";
   WebhookEventType2["SubscriptionPaymentSucceeded"] = "subscription.payment_succeeded";
+  WebhookEventType2["SubscriptionRenewed"] = "subscription.renewed";
+  WebhookEventType2["SubscriptionRecovered"] = "subscription.recovered";
+  WebhookEventType2["SubscriptionPlanChanged"] = "subscription.plan_changed";
+  WebhookEventType2["SubscriptionPlanChangeScheduled"] = "subscription.plan_change_scheduled";
+  WebhookEventType2["SubscriptionPlanChangeFailed"] = "subscription.plan_change_failed";
   WebhookEventType2["SubscriptionCanceling"] = "subscription.canceling";
   WebhookEventType2["SubscriptionUncanceled"] = "subscription.uncanceled";
-  WebhookEventType2["SubscriptionUpdated"] = "subscription.updated";
   WebhookEventType2["SubscriptionCanceled"] = "subscription.canceled";
   WebhookEventType2["SubscriptionPastDue"] = "subscription.past_due";
   WebhookEventType2["RefundSucceeded"] = "refund.succeeded";