rebilly-js-sdk 62.231.0 → 62.232.0

package/CHANGELOG.md

@@ -1,3 +1,3 @@
-## 62.231.0 (2026-10-22)
+## 62.232.0 (2026-10-22)
 
 This was a version bump only for rebilly-js-sdk to align it with other projects, there were no code changes.

package/dist/rebilly-js-sdk.d.cts

@@ -13799,7 +13799,11 @@ export interface coreComponents {
       canceledTime?: string | null;
       /** Specifies who initiated the cancellation. */
       canceledBy?: ("merchant" | "customer" | "rebilly") | null;
-      /** Category of the cancellation. */
+      /**
+       * Category of the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       */
       cancelCategory?:
         | (
             | "billing-failure"
@@ -13815,6 +13819,7 @@ export interface coreComponents {
             | "never-started"
             | "switched-plan"
             | "organization-deactivated"
+            | "sandbox-retention"
             | "other"
           )
         | null;
@@ -14451,7 +14456,11 @@ export interface coreComponents {
       cancellationTime?: string | null;
       /** Specifies who initiated the cancellation. */
       canceledBy?: ("merchant" | "customer" | "rebilly") | null;
-      /** Category of the cancellation. */
+      /**
+       * Category of the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       */
       cancelCategory?:
         | (
             | "billing-failure"
@@ -14465,6 +14474,9 @@ export interface coreComponents {
             | "too-expensive"
             | "never-started"
             | "switched-plan"
+            | "organization-deactivated"
+            | "delinquency"
+            | "sandbox-retention"
             | "other"
           )
         | null;
@@ -14765,7 +14777,12 @@ export interface coreComponents {
       appliedInvoiceId?: string | null;
       /** Specifies who initiated the cancellation. */
       canceledBy?: "merchant" | "customer" | "rebilly";
-      /** Reason for the cancellation. */
+      /**
+       * Reason for the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       * If a request includes it, a validation error is returned.
+       */
       reason?:
         | "did-not-use"
         | "did-not-want"
@@ -14776,7 +14793,10 @@ export interface coreComponents {
         | "contract-expired"
         | "too-expensive"
         | "other"
-        | "billing-failure";
+        | "billing-failure"
+        | "delinquency"
+        | "organization-deactivated"
+        | "sandbox-retention";
       /** Description of the cancellation reason in free form. */
       description?: string;
       /** Specifies if the customer gets a pro-rata credit for the time remaining between `churnTime` and order next renewal time. */
@@ -15061,7 +15081,12 @@ export interface coreComponents {
       appliedInvoiceId?: string | null;
       /** Specifies who initiated the cancellation. */
       canceledBy?: "merchant" | "customer" | "rebilly";
-      /** Reason for the cancellation. */
+      /**
+       * Reason for the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       * If a request includes it, a validation error is returned.
+       */
       reason?:
         | "did-not-use"
         | "did-not-want"
@@ -15072,7 +15097,10 @@ export interface coreComponents {
         | "contract-expired"
         | "too-expensive"
         | "other"
-        | "billing-failure";
+        | "billing-failure"
+        | "delinquency"
+        | "organization-deactivated"
+        | "sandbox-retention";
       /** Description of the cancellation reason in free form. */
       description?: string;
       /** Specifies if the customer gets a pro-rata credit for the time remaining between `churnTime` and subscription next renewal time. */
@@ -26999,7 +27027,11 @@ export interface coreComponents {
       canceledTime?: string;
       /** Specifies who initiated the cancellation. */
       canceledBy?: "merchant" | "customer" | "rebilly";
-      /** Category of the cancellation. */
+      /**
+       * Category of the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       */
       cancelCategory?:
         | "billing-failure"
         | "delinquency"
@@ -27014,6 +27046,7 @@ export interface coreComponents {
         | "never-started"
         | "switched-plan"
         | "organization-deactivated"
+        | "sandbox-retention"
         | "other";
       /** Description of the cancellation reason in free form. */
       cancelDescription?: string;
@@ -54046,7 +54079,11 @@ export interface storefrontComponents {
       canceledTime?: string | null;
       /** Specifies who initiated the cancellation. */
       canceledBy?: ("merchant" | "customer" | "rebilly") | null;
-      /** Category of the cancellation. */
+      /**
+       * Category of the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       */
       cancelCategory?:
         | (
             | "billing-failure"
@@ -54062,6 +54099,7 @@ export interface storefrontComponents {
             | "never-started"
             | "switched-plan"
             | "organization-deactivated"
+            | "sandbox-retention"
             | "other"
           )
         | null;
@@ -54698,7 +54736,11 @@ export interface storefrontComponents {
       cancellationTime?: string | null;
       /** Specifies who initiated the cancellation. */
       canceledBy?: ("merchant" | "customer" | "rebilly") | null;
-      /** Category of the cancellation. */
+      /**
+       * Category of the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       */
       cancelCategory?:
         | (
             | "billing-failure"
@@ -54712,6 +54754,9 @@ export interface storefrontComponents {
             | "too-expensive"
             | "never-started"
             | "switched-plan"
+            | "organization-deactivated"
+            | "delinquency"
+            | "sandbox-retention"
             | "other"
           )
         | null;
@@ -55012,7 +55057,12 @@ export interface storefrontComponents {
       appliedInvoiceId?: string | null;
       /** Specifies who initiated the cancellation. */
       canceledBy?: "merchant" | "customer" | "rebilly";
-      /** Reason for the cancellation. */
+      /**
+       * Reason for the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       * If a request includes it, a validation error is returned.
+       */
       reason?:
         | "did-not-use"
         | "did-not-want"
@@ -55023,7 +55073,10 @@ export interface storefrontComponents {
         | "contract-expired"
         | "too-expensive"
         | "other"
-        | "billing-failure";
+        | "billing-failure"
+        | "delinquency"
+        | "organization-deactivated"
+        | "sandbox-retention";
       /** Description of the cancellation reason in free form. */
       description?: string;
       /** Specifies if the customer gets a pro-rata credit for the time remaining between `churnTime` and order next renewal time. */
@@ -55308,7 +55361,12 @@ export interface storefrontComponents {
       appliedInvoiceId?: string | null;
       /** Specifies who initiated the cancellation. */
       canceledBy?: "merchant" | "customer" | "rebilly";
-      /** Reason for the cancellation. */
+      /**
+       * Reason for the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       * If a request includes it, a validation error is returned.
+       */
       reason?:
         | "did-not-use"
         | "did-not-want"
@@ -55319,7 +55377,10 @@ export interface storefrontComponents {
         | "contract-expired"
         | "too-expensive"
         | "other"
-        | "billing-failure";
+        | "billing-failure"
+        | "delinquency"
+        | "organization-deactivated"
+        | "sandbox-retention";
       /** Description of the cancellation reason in free form. */
       description?: string;
       /** Specifies if the customer gets a pro-rata credit for the time remaining between `churnTime` and subscription next renewal time. */
@@ -67246,7 +67307,11 @@ export interface storefrontComponents {
       canceledTime?: string;
       /** Specifies who initiated the cancellation. */
       canceledBy?: "merchant" | "customer" | "rebilly";
-      /** Category of the cancellation. */
+      /**
+       * Category of the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       */
       cancelCategory?:
         | "billing-failure"
         | "delinquency"
@@ -67261,6 +67326,7 @@ export interface storefrontComponents {
         | "never-started"
         | "switched-plan"
         | "organization-deactivated"
+        | "sandbox-retention"
         | "other";
       /** Description of the cancellation reason in free form. */
       cancelDescription?: string;
@@ -81521,7 +81587,11 @@ export interface reportsComponents {
       canceledTime?: string | null;
       /** Specifies who initiated the cancellation. */
       canceledBy?: ("merchant" | "customer" | "rebilly") | null;
-      /** Category of the cancellation. */
+      /**
+       * Category of the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       */
       cancelCategory?:
         | (
             | "billing-failure"
@@ -81537,6 +81607,7 @@ export interface reportsComponents {
             | "never-started"
             | "switched-plan"
             | "organization-deactivated"
+            | "sandbox-retention"
             | "other"
           )
         | null;
@@ -82173,7 +82244,11 @@ export interface reportsComponents {
       cancellationTime?: string | null;
       /** Specifies who initiated the cancellation. */
       canceledBy?: ("merchant" | "customer" | "rebilly") | null;
-      /** Category of the cancellation. */
+      /**
+       * Category of the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       */
       cancelCategory?:
         | (
             | "billing-failure"
@@ -82187,6 +82262,9 @@ export interface reportsComponents {
             | "too-expensive"
             | "never-started"
             | "switched-plan"
+            | "organization-deactivated"
+            | "delinquency"
+            | "sandbox-retention"
             | "other"
           )
         | null;
@@ -82487,7 +82565,12 @@ export interface reportsComponents {
       appliedInvoiceId?: string | null;
       /** Specifies who initiated the cancellation. */
       canceledBy?: "merchant" | "customer" | "rebilly";
-      /** Reason for the cancellation. */
+      /**
+       * Reason for the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       * If a request includes it, a validation error is returned.
+       */
       reason?:
         | "did-not-use"
         | "did-not-want"
@@ -82498,7 +82581,10 @@ export interface reportsComponents {
         | "contract-expired"
         | "too-expensive"
         | "other"
-        | "billing-failure";
+        | "billing-failure"
+        | "delinquency"
+        | "organization-deactivated"
+        | "sandbox-retention";
       /** Description of the cancellation reason in free form. */
       description?: string;
       /** Specifies if the customer gets a pro-rata credit for the time remaining between `churnTime` and order next renewal time. */
@@ -82783,7 +82869,12 @@ export interface reportsComponents {
       appliedInvoiceId?: string | null;
       /** Specifies who initiated the cancellation. */
       canceledBy?: "merchant" | "customer" | "rebilly";
-      /** Reason for the cancellation. */
+      /**
+       * Reason for the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       * If a request includes it, a validation error is returned.
+       */
       reason?:
         | "did-not-use"
         | "did-not-want"
@@ -82794,7 +82885,10 @@ export interface reportsComponents {
         | "contract-expired"
         | "too-expensive"
         | "other"
-        | "billing-failure";
+        | "billing-failure"
+        | "delinquency"
+        | "organization-deactivated"
+        | "sandbox-retention";
       /** Description of the cancellation reason in free form. */
       description?: string;
       /** Specifies if the customer gets a pro-rata credit for the time remaining between `churnTime` and subscription next renewal time. */
@@ -94721,7 +94815,11 @@ export interface reportsComponents {
       canceledTime?: string;
       /** Specifies who initiated the cancellation. */
       canceledBy?: "merchant" | "customer" | "rebilly";
-      /** Category of the cancellation. */
+      /**
+       * Category of the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       */
       cancelCategory?:
         | "billing-failure"
         | "delinquency"
@@ -94736,6 +94834,7 @@ export interface reportsComponents {
         | "never-started"
         | "switched-plan"
         | "organization-deactivated"
+        | "sandbox-retention"
         | "other";
       /** Description of the cancellation reason in free form. */
       cancelDescription?: string;