@waffo/pancake-ts 0.19.0 → 0.19.1

package/dist/index.cjs

@@ -588,7 +588,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");
@@ -610,6 +612,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
    *
@@ -808,8 +816,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