@waffo/pancake-ts 0.19.0 → 0.19.1

package/dist/index.d.cts

@@ -177,7 +177,7 @@ declare enum OnetimeOrderStatus {
  * - pending -> active, canceled, closed (PSP CLOSE from never-activated)
  * - active -> canceling, past_due, canceled, expired
  * - canceling -> active, canceled
- * - past_due -> active, canceled
+ * - past_due -> active, canceling, canceled
  * - closed -> terminal (never-activated subscription closed by PSP)
  * - canceled -> terminal
  * - expired -> terminal
@@ -1571,7 +1571,9 @@ declare class CustomerSession {
      *
      * @example
      * const { orderId, status } = await customer.cancelSubscription({ orderId: "ORD_xxx" });
-     * // status: "canceled" (was pending) or "canceling" (was active)
+     * // status: "canceled" (was pending)
+     * //      or "canceling" (was active — stops at the end of the current period)
+     * //      or "canceling" (was past_due — stops immediately)
      */
     cancelSubscription(params: CancelSubscriptionParams): Promise<CancelSubscriptionResult & {
         warnings?: Notice[];
@@ -1591,6 +1593,12 @@ declare class CustomerSession {
     /**
      * Reactivate a subscription that is in `canceling` status.
      *
+     * A subscription that had an unpaid charge at the moment cancellation was
+     * requested is refused with 400 (`Subscription with an unpaid balance cannot
+     * be reactivated`), which is worded differently from the 400 returned when
+     * the order is not in `canceling` status. Cancelling a `past_due`
+     * subscription always falls into the former category.
+     *
      * @param params - Order to reactivate
      * @returns Order ID and resulting status
      *
@@ -1766,8 +1774,14 @@ declare class OrdersResource {
     /**
      * Cancel a subscription order.
      *
-     * - pending -> canceled (immediate)
-     * - active/trialing -> canceling (PSP cancel, webhook updates later)
+     * - pending -> canceled (immediate, no PSP call)
+     * - active/trialing -> canceling (PSP cancel scheduled for the end of the
+     *   current billing period; the subscription stays usable until then)
+     * - past_due -> canceling (PSP cancel dispatched immediately; the billing
+     *   period has already lapsed, so nothing is left to use)
+     *
+     * In both canceling cases the terminal `canceled` status is written when the
+     * PSP cancellation webhook arrives, not by this call.
      *
      * @param params - Order to cancel
      * @returns Order ID and resulting status

package/dist/index.d.ts

@@ -177,7 +177,7 @@ declare enum OnetimeOrderStatus {
  * - pending -> active, canceled, closed (PSP CLOSE from never-activated)
  * - active -> canceling, past_due, canceled, expired
  * - canceling -> active, canceled
- * - past_due -> active, canceled
+ * - past_due -> active, canceling, canceled
  * - closed -> terminal (never-activated subscription closed by PSP)
  * - canceled -> terminal
  * - expired -> terminal
@@ -1571,7 +1571,9 @@ declare class CustomerSession {
      *
      * @example
      * const { orderId, status } = await customer.cancelSubscription({ orderId: "ORD_xxx" });
-     * // status: "canceled" (was pending) or "canceling" (was active)
+     * // status: "canceled" (was pending)
+     * //      or "canceling" (was active — stops at the end of the current period)
+     * //      or "canceling" (was past_due — stops immediately)
      */
     cancelSubscription(params: CancelSubscriptionParams): Promise<CancelSubscriptionResult & {
         warnings?: Notice[];
@@ -1591,6 +1593,12 @@ declare class CustomerSession {
     /**
      * Reactivate a subscription that is in `canceling` status.
      *
+     * A subscription that had an unpaid charge at the moment cancellation was
+     * requested is refused with 400 (`Subscription with an unpaid balance cannot
+     * be reactivated`), which is worded differently from the 400 returned when
+     * the order is not in `canceling` status. Cancelling a `past_due`
+     * subscription always falls into the former category.
+     *
      * @param params - Order to reactivate
      * @returns Order ID and resulting status
      *
@@ -1766,8 +1774,14 @@ declare class OrdersResource {
     /**
      * Cancel a subscription order.
      *
-     * - pending -> canceled (immediate)
-     * - active/trialing -> canceling (PSP cancel, webhook updates later)
+     * - pending -> canceled (immediate, no PSP call)
+     * - active/trialing -> canceling (PSP cancel scheduled for the end of the
+     *   current billing period; the subscription stays usable until then)
+     * - past_due -> canceling (PSP cancel dispatched immediately; the billing
+     *   period has already lapsed, so nothing is left to use)
+     *
+     * In both canceling cases the terminal `canceled` status is written when the
+     * PSP cancellation webhook arrives, not by this call.
      *
      * @param params - Order to cancel
      * @returns Order ID and resulting status

package/dist/index.js

@@ -541,7 +541,9 @@ var CustomerSession = class {
    *
    * @example
    * const { orderId, status } = await customer.cancelSubscription({ orderId: "ORD_xxx" });
-   * // status: "canceled" (was pending) or "canceling" (was active)
+   * // status: "canceled" (was pending)
+   * //      or "canceling" (was active — stops at the end of the current period)
+   * //      or "canceling" (was past_due — stops immediately)
    */
   async cancelSubscription(params) {
     validateShortId("orderId", params.orderId, "ORD");
@@ -563,6 +565,12 @@ var CustomerSession = class {
   /**
    * Reactivate a subscription that is in `canceling` status.
    *
+   * A subscription that had an unpaid charge at the moment cancellation was
+   * requested is refused with 400 (`Subscription with an unpaid balance cannot
+   * be reactivated`), which is worded differently from the 400 returned when
+   * the order is not in `canceling` status. Cancelling a `past_due`
+   * subscription always falls into the former category.
+   *
    * @param params - Order to reactivate
    * @returns Order ID and resulting status
    *
@@ -761,8 +769,14 @@ var OrdersResource = class {
   /**
    * Cancel a subscription order.
    *
-   * - pending -> canceled (immediate)
-   * - active/trialing -> canceling (PSP cancel, webhook updates later)
+   * - pending -> canceled (immediate, no PSP call)
+   * - active/trialing -> canceling (PSP cancel scheduled for the end of the
+   *   current billing period; the subscription stays usable until then)
+   * - past_due -> canceling (PSP cancel dispatched immediately; the billing
+   *   period has already lapsed, so nothing is left to use)
+   *
+   * In both canceling cases the terminal `canceled` status is written when the
+   * PSP cancellation webhook arrives, not by this call.
    *
    * @param params - Order to cancel
    * @returns Order ID and resulting status