API Updates (#1226)

types/2020-08-27/BillingPortal/Configurations.d.ts

@@ -126,6 +126,8 @@ declare module 'stripe' {
           }
 
           interface SubscriptionCancel {
+            cancellation_reason?: SubscriptionCancel.CancellationReason;
+
             /**
              * Whether the feature is enabled.
              */
@@ -143,6 +145,30 @@ declare module 'stripe' {
           }
 
           namespace SubscriptionCancel {
+            interface CancellationReason {
+              /**
+               * Whether the feature is enabled.
+               */
+              enabled: boolean;
+
+              /**
+               * Which cancellation reasons will be given as options to the customer.
+               */
+              options: Array<CancellationReason.Option>;
+            }
+
+            namespace CancellationReason {
+              type Option =
+                | 'customer_service'
+                | 'low_quality'
+                | 'missing_features'
+                | 'other'
+                | 'switched_service'
+                | 'too_complex'
+                | 'too_expensive'
+                | 'unused';
+            }
+
             type Mode = 'at_period_end' | 'immediately';
 
             type ProrationBehavior =
@@ -316,6 +342,11 @@ declare module 'stripe' {
           }
 
           interface SubscriptionCancel {
+            /**
+             * Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer
+             */
+            cancellation_reason?: SubscriptionCancel.CancellationReason;
+
             /**
              * Whether the feature is enabled.
              */
@@ -333,6 +364,30 @@ declare module 'stripe' {
           }
 
           namespace SubscriptionCancel {
+            interface CancellationReason {
+              /**
+               * Whether the feature is enabled.
+               */
+              enabled: boolean;
+
+              /**
+               * Which cancellation reasons will be given as options to the customer.
+               */
+              options: Stripe.Emptyable<Array<CancellationReason.Option>>;
+            }
+
+            namespace CancellationReason {
+              type Option =
+                | 'customer_service'
+                | 'low_quality'
+                | 'missing_features'
+                | 'other'
+                | 'switched_service'
+                | 'too_complex'
+                | 'too_expensive'
+                | 'unused';
+            }
+
             type Mode = 'at_period_end' | 'immediately';
 
             type ProrationBehavior =
@@ -518,6 +573,11 @@ declare module 'stripe' {
           }
 
           interface SubscriptionCancel {
+            /**
+             * Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer
+             */
+            cancellation_reason?: SubscriptionCancel.CancellationReason;
+
             /**
              * Whether the feature is enabled.
              */
@@ -535,6 +595,30 @@ declare module 'stripe' {
           }
 
           namespace SubscriptionCancel {
+            interface CancellationReason {
+              /**
+               * Whether the feature is enabled.
+               */
+              enabled: boolean;
+
+              /**
+               * Which cancellation reasons will be given as options to the customer.
+               */
+              options?: Stripe.Emptyable<Array<CancellationReason.Option>>;
+            }
+
+            namespace CancellationReason {
+              type Option =
+                | 'customer_service'
+                | 'low_quality'
+                | 'missing_features'
+                | 'other'
+                | 'switched_service'
+                | 'too_complex'
+                | 'too_expensive'
+                | 'unused';
+            }
+
             type Mode = 'at_period_end' | 'immediately';
 
             type ProrationBehavior =