From 39b0d2f07f6c74448e30c9ec06cba1385e9e72b8 Mon Sep 17 00:00:00 2001
From: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com>
Date: Tue, 22 Aug 2023 20:07:28 +0000
Subject: [PATCH] Update OpenAPI specification

---
 openapi/spec3.beta.sdk.json | 101 +++++++++++++++++++++++++++++++++++-
 openapi/spec3.beta.sdk.yaml |  77 ++++++++++++++++++++++++++-
 openapi/spec3.json          |  87 ++++++++++++++++++++++++++++++-
 openapi/spec3.sdk.json      | 101 +++++++++++++++++++++++++++++++++++-
 openapi/spec3.sdk.yaml      |  77 ++++++++++++++++++++++++++-
 openapi/spec3.yaml          |  59 ++++++++++++++++++++-
 6 files changed, 496 insertions(+), 6 deletions(-)

diff --git a/openapi/spec3.beta.sdk.json b/openapi/spec3.beta.sdk.json
index b3027e42..22bc5146 100644
--- a/openapi/spec3.beta.sdk.json
+++ b/openapi/spec3.beta.sdk.json
@@ -38062,6 +38062,26 @@
           "in_package": ""
         }
       },
+      "portal_flows_coupon_offer": {
+        "description": "",
+        "properties": {
+          "coupon": {
+            "description": "The ID of the coupon to be offered.",
+            "maxLength": 5000,
+            "type": "string"
+          }
+        },
+        "required": [
+          "coupon"
+        ],
+        "title": "PortalFlowsCouponOffer",
+        "type": "object",
+        "x-expandableFields": [],
+        "x-stripeResource": {
+          "class_name": "CouponOffer",
+          "in_package": ""
+        }
+      },
       "portal_flows_flow": {
         "description": "",
         "properties": {
@@ -38176,6 +38196,15 @@
       "portal_flows_flow_subscription_cancel": {
         "description": "",
         "properties": {
+          "retention": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/portal_flows_retention"
+              }
+            ],
+            "description": "Specify a retention strategy to be used in the cancellation flow.",
+            "nullable": true
+          },
           "subscription": {
             "description": "The ID of the subscription to be canceled.",
             "maxLength": 5000,
@@ -38183,11 +38212,14 @@
           }
         },
         "required": [
+          "retention",
           "subscription"
         ],
         "title": "PortalFlowsFlowSubscriptionCancel",
         "type": "object",
-        "x-expandableFields": [],
+        "x-expandableFields": [
+          "retention"
+        ],
         "x-stripeResource": {
           "class_name": "SubscriptionCancel",
           "in_package": ""
@@ -38253,6 +38285,40 @@
           "in_package": ""
         }
       },
+      "portal_flows_retention": {
+        "description": "",
+        "properties": {
+          "coupon_offer": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/portal_flows_coupon_offer"
+              }
+            ],
+            "description": "Configuration when `retention.type=coupon_offer`.",
+            "nullable": true
+          },
+          "type": {
+            "description": "Type of retention strategy that will be used.",
+            "enum": [
+              "coupon_offer"
+            ],
+            "type": "string"
+          }
+        },
+        "required": [
+          "coupon_offer",
+          "type"
+        ],
+        "title": "PortalFlowsRetention",
+        "type": "object",
+        "x-expandableFields": [
+          "coupon_offer"
+        ],
+        "x-stripeResource": {
+          "class_name": "Retention",
+          "in_package": ""
+        }
+      },
       "portal_flows_subscription_update_confirm_discount": {
         "description": "",
         "properties": {
@@ -67939,6 +68005,39 @@
                       "subscription_cancel": {
                         "description": "Configuration when `flow_data.type=subscription_cancel`.",
                         "properties": {
+                          "retention": {
+                            "description": "Specify a retention strategy to be used in the cancellation flow.",
+                            "properties": {
+                              "coupon_offer": {
+                                "description": "Configuration when `retention.type=coupon_offer`.",
+                                "properties": {
+                                  "coupon": {
+                                    "description": "The ID of the coupon to be offered.",
+                                    "maxLength": 5000,
+                                    "type": "string"
+                                  }
+                                },
+                                "required": [
+                                  "coupon"
+                                ],
+                                "title": "coupon_offer_param",
+                                "type": "object"
+                              },
+                              "type": {
+                                "description": "Type of retention strategy to use with the customer.",
+                                "enum": [
+                                  "coupon_offer"
+                                ],
+                                "type": "string"
+                              }
+                            },
+                            "required": [
+                              "coupon_offer",
+                              "type"
+                            ],
+                            "title": "retention_param",
+                            "type": "object"
+                          },
                           "subscription": {
                             "description": "The ID of the subscription to be canceled.",
                             "maxLength": 5000,
diff --git a/openapi/spec3.beta.sdk.yaml b/openapi/spec3.beta.sdk.yaml
index 2be45e43..b3fae237 100644
--- a/openapi/spec3.beta.sdk.yaml
+++ b/openapi/spec3.beta.sdk.yaml
@@ -35132,6 +35132,21 @@ components:
       x-stripeResource:
         class_name: Redirect
         in_package: ''
+    portal_flows_coupon_offer:
+      description: ''
+      properties:
+        coupon:
+          description: The ID of the coupon to be offered.
+          maxLength: 5000
+          type: string
+      required:
+        - coupon
+      title: PortalFlowsCouponOffer
+      type: object
+      x-expandableFields: []
+      x-stripeResource:
+        class_name: CouponOffer
+        in_package: ''
     portal_flows_flow:
       description: ''
       properties:
@@ -35213,15 +35228,22 @@ components:
     portal_flows_flow_subscription_cancel:
       description: ''
       properties:
+        retention:
+          anyOf:
+            - $ref: '#/components/schemas/portal_flows_retention'
+          description: Specify a retention strategy to be used in the cancellation flow.
+          nullable: true
         subscription:
           description: The ID of the subscription to be canceled.
           maxLength: 5000
           type: string
       required:
+        - retention
         - subscription
       title: PortalFlowsFlowSubscriptionCancel
       type: object
-      x-expandableFields: []
+      x-expandableFields:
+        - retention
       x-stripeResource:
         class_name: SubscriptionCancel
         in_package: ''
@@ -35277,6 +35299,29 @@ components:
       x-stripeResource:
         class_name: SubscriptionUpdateConfirm
         in_package: ''
+    portal_flows_retention:
+      description: ''
+      properties:
+        coupon_offer:
+          anyOf:
+            - $ref: '#/components/schemas/portal_flows_coupon_offer'
+          description: Configuration when `retention.type=coupon_offer`.
+          nullable: true
+        type:
+          description: Type of retention strategy that will be used.
+          enum:
+            - coupon_offer
+          type: string
+      required:
+        - coupon_offer
+        - type
+      title: PortalFlowsRetention
+      type: object
+      x-expandableFields:
+        - coupon_offer
+      x-stripeResource:
+        class_name: Retention
+        in_package: ''
     portal_flows_subscription_update_confirm_discount:
       description: ''
       properties:
@@ -61681,6 +61726,36 @@ paths:
                     subscription_cancel:
                       description: Configuration when `flow_data.type=subscription_cancel`.
                       properties:
+                        retention:
+                          description: >-
+                            Specify a retention strategy to be used in the
+                            cancellation flow.
+                          properties:
+                            coupon_offer:
+                              description: >-
+                                Configuration when
+                                `retention.type=coupon_offer`.
+                              properties:
+                                coupon:
+                                  description: The ID of the coupon to be offered.
+                                  maxLength: 5000
+                                  type: string
+                              required:
+                                - coupon
+                              title: coupon_offer_param
+                              type: object
+                            type:
+                              description: >-
+                                Type of retention strategy to use with the
+                                customer.
+                              enum:
+                                - coupon_offer
+                              type: string
+                          required:
+                            - coupon_offer
+                            - type
+                          title: retention_param
+                          type: object
                         subscription:
                           description: The ID of the subscription to be canceled.
                           maxLength: 5000
diff --git a/openapi/spec3.json b/openapi/spec3.json
index 41d34e84..112a523a 100644
--- a/openapi/spec3.json
+++ b/openapi/spec3.json
@@ -28534,6 +28534,22 @@
         "type": "object",
         "x-expandableFields": []
       },
+      "portal_flows_coupon_offer": {
+        "description": "",
+        "properties": {
+          "coupon": {
+            "description": "The ID of the coupon to be offered.",
+            "maxLength": 5000,
+            "type": "string"
+          }
+        },
+        "required": [
+          "coupon"
+        ],
+        "title": "PortalFlowsCouponOffer",
+        "type": "object",
+        "x-expandableFields": []
+      },
       "portal_flows_flow": {
         "description": "",
         "properties": {
@@ -28635,6 +28651,15 @@
       "portal_flows_flow_subscription_cancel": {
         "description": "",
         "properties": {
+          "retention": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/portal_flows_retention"
+              }
+            ],
+            "description": "Specify a retention strategy to be used in the cancellation flow.",
+            "nullable": true
+          },
           "subscription": {
             "description": "The ID of the subscription to be canceled.",
             "maxLength": 5000,
@@ -28646,7 +28671,9 @@
         ],
         "title": "PortalFlowsFlowSubscriptionCancel",
         "type": "object",
-        "x-expandableFields": []
+        "x-expandableFields": [
+          "retention"
+        ]
       },
       "portal_flows_flow_subscription_update": {
         "description": "",
@@ -28699,6 +28726,35 @@
           "items"
         ]
       },
+      "portal_flows_retention": {
+        "description": "",
+        "properties": {
+          "coupon_offer": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/portal_flows_coupon_offer"
+              }
+            ],
+            "description": "Configuration when `retention.type=coupon_offer`.",
+            "nullable": true
+          },
+          "type": {
+            "description": "Type of retention strategy that will be used.",
+            "enum": [
+              "coupon_offer"
+            ],
+            "type": "string"
+          }
+        },
+        "required": [
+          "type"
+        ],
+        "title": "PortalFlowsRetention",
+        "type": "object",
+        "x-expandableFields": [
+          "coupon_offer"
+        ]
+      },
       "portal_flows_subscription_update_confirm_discount": {
         "description": "",
         "properties": {
@@ -53086,6 +53142,35 @@
                       },
                       "subscription_cancel": {
                         "properties": {
+                          "retention": {
+                            "properties": {
+                              "coupon_offer": {
+                                "properties": {
+                                  "coupon": {
+                                    "maxLength": 5000,
+                                    "type": "string"
+                                  }
+                                },
+                                "required": [
+                                  "coupon"
+                                ],
+                                "title": "coupon_offer_param",
+                                "type": "object"
+                              },
+                              "type": {
+                                "enum": [
+                                  "coupon_offer"
+                                ],
+                                "type": "string"
+                              }
+                            },
+                            "required": [
+                              "coupon_offer",
+                              "type"
+                            ],
+                            "title": "retention_param",
+                            "type": "object"
+                          },
                           "subscription": {
                             "maxLength": 5000,
                             "type": "string"
diff --git a/openapi/spec3.sdk.json b/openapi/spec3.sdk.json
index 7dcbab76..d076dc25 100644
--- a/openapi/spec3.sdk.json
+++ b/openapi/spec3.sdk.json
@@ -34025,6 +34025,26 @@
           "in_package": ""
         }
       },
+      "portal_flows_coupon_offer": {
+        "description": "",
+        "properties": {
+          "coupon": {
+            "description": "The ID of the coupon to be offered.",
+            "maxLength": 5000,
+            "type": "string"
+          }
+        },
+        "required": [
+          "coupon"
+        ],
+        "title": "PortalFlowsCouponOffer",
+        "type": "object",
+        "x-expandableFields": [],
+        "x-stripeResource": {
+          "class_name": "CouponOffer",
+          "in_package": ""
+        }
+      },
       "portal_flows_flow": {
         "description": "",
         "properties": {
@@ -34139,6 +34159,15 @@
       "portal_flows_flow_subscription_cancel": {
         "description": "",
         "properties": {
+          "retention": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/portal_flows_retention"
+              }
+            ],
+            "description": "Specify a retention strategy to be used in the cancellation flow.",
+            "nullable": true
+          },
           "subscription": {
             "description": "The ID of the subscription to be canceled.",
             "maxLength": 5000,
@@ -34146,11 +34175,14 @@
           }
         },
         "required": [
+          "retention",
           "subscription"
         ],
         "title": "PortalFlowsFlowSubscriptionCancel",
         "type": "object",
-        "x-expandableFields": [],
+        "x-expandableFields": [
+          "retention"
+        ],
         "x-stripeResource": {
           "class_name": "SubscriptionCancel",
           "in_package": ""
@@ -34216,6 +34248,40 @@
           "in_package": ""
         }
       },
+      "portal_flows_retention": {
+        "description": "",
+        "properties": {
+          "coupon_offer": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/portal_flows_coupon_offer"
+              }
+            ],
+            "description": "Configuration when `retention.type=coupon_offer`.",
+            "nullable": true
+          },
+          "type": {
+            "description": "Type of retention strategy that will be used.",
+            "enum": [
+              "coupon_offer"
+            ],
+            "type": "string"
+          }
+        },
+        "required": [
+          "coupon_offer",
+          "type"
+        ],
+        "title": "PortalFlowsRetention",
+        "type": "object",
+        "x-expandableFields": [
+          "coupon_offer"
+        ],
+        "x-stripeResource": {
+          "class_name": "Retention",
+          "in_package": ""
+        }
+      },
       "portal_flows_subscription_update_confirm_discount": {
         "description": "",
         "properties": {
@@ -60143,6 +60209,39 @@
                       "subscription_cancel": {
                         "description": "Configuration when `flow_data.type=subscription_cancel`.",
                         "properties": {
+                          "retention": {
+                            "description": "Specify a retention strategy to be used in the cancellation flow.",
+                            "properties": {
+                              "coupon_offer": {
+                                "description": "Configuration when `retention.type=coupon_offer`.",
+                                "properties": {
+                                  "coupon": {
+                                    "description": "The ID of the coupon to be offered.",
+                                    "maxLength": 5000,
+                                    "type": "string"
+                                  }
+                                },
+                                "required": [
+                                  "coupon"
+                                ],
+                                "title": "coupon_offer_param",
+                                "type": "object"
+                              },
+                              "type": {
+                                "description": "Type of retention strategy to use with the customer.",
+                                "enum": [
+                                  "coupon_offer"
+                                ],
+                                "type": "string"
+                              }
+                            },
+                            "required": [
+                              "coupon_offer",
+                              "type"
+                            ],
+                            "title": "retention_param",
+                            "type": "object"
+                          },
                           "subscription": {
                             "description": "The ID of the subscription to be canceled.",
                             "maxLength": 5000,
diff --git a/openapi/spec3.sdk.yaml b/openapi/spec3.sdk.yaml
index e31644db..8048f087 100644
--- a/openapi/spec3.sdk.yaml
+++ b/openapi/spec3.sdk.yaml
@@ -31492,6 +31492,21 @@ components:
       x-stripeResource:
         class_name: Redirect
         in_package: ''
+    portal_flows_coupon_offer:
+      description: ''
+      properties:
+        coupon:
+          description: The ID of the coupon to be offered.
+          maxLength: 5000
+          type: string
+      required:
+        - coupon
+      title: PortalFlowsCouponOffer
+      type: object
+      x-expandableFields: []
+      x-stripeResource:
+        class_name: CouponOffer
+        in_package: ''
     portal_flows_flow:
       description: ''
       properties:
@@ -31573,15 +31588,22 @@ components:
     portal_flows_flow_subscription_cancel:
       description: ''
       properties:
+        retention:
+          anyOf:
+            - $ref: '#/components/schemas/portal_flows_retention'
+          description: Specify a retention strategy to be used in the cancellation flow.
+          nullable: true
         subscription:
           description: The ID of the subscription to be canceled.
           maxLength: 5000
           type: string
       required:
+        - retention
         - subscription
       title: PortalFlowsFlowSubscriptionCancel
       type: object
-      x-expandableFields: []
+      x-expandableFields:
+        - retention
       x-stripeResource:
         class_name: SubscriptionCancel
         in_package: ''
@@ -31637,6 +31659,29 @@ components:
       x-stripeResource:
         class_name: SubscriptionUpdateConfirm
         in_package: ''
+    portal_flows_retention:
+      description: ''
+      properties:
+        coupon_offer:
+          anyOf:
+            - $ref: '#/components/schemas/portal_flows_coupon_offer'
+          description: Configuration when `retention.type=coupon_offer`.
+          nullable: true
+        type:
+          description: Type of retention strategy that will be used.
+          enum:
+            - coupon_offer
+          type: string
+      required:
+        - coupon_offer
+        - type
+      title: PortalFlowsRetention
+      type: object
+      x-expandableFields:
+        - coupon_offer
+      x-stripeResource:
+        class_name: Retention
+        in_package: ''
     portal_flows_subscription_update_confirm_discount:
       description: ''
       properties:
@@ -54953,6 +54998,36 @@ paths:
                     subscription_cancel:
                       description: Configuration when `flow_data.type=subscription_cancel`.
                       properties:
+                        retention:
+                          description: >-
+                            Specify a retention strategy to be used in the
+                            cancellation flow.
+                          properties:
+                            coupon_offer:
+                              description: >-
+                                Configuration when
+                                `retention.type=coupon_offer`.
+                              properties:
+                                coupon:
+                                  description: The ID of the coupon to be offered.
+                                  maxLength: 5000
+                                  type: string
+                              required:
+                                - coupon
+                              title: coupon_offer_param
+                              type: object
+                            type:
+                              description: >-
+                                Type of retention strategy to use with the
+                                customer.
+                              enum:
+                                - coupon_offer
+                              type: string
+                          required:
+                            - coupon_offer
+                            - type
+                          title: retention_param
+                          type: object
                         subscription:
                           description: The ID of the subscription to be canceled.
                           maxLength: 5000
diff --git a/openapi/spec3.yaml b/openapi/spec3.yaml
index a8942058..16124b9d 100644
--- a/openapi/spec3.yaml
+++ b/openapi/spec3.yaml
@@ -27062,6 +27062,18 @@ components:
       title: PortalFlowsAfterCompletionRedirect
       type: object
       x-expandableFields: []
+    portal_flows_coupon_offer:
+      description: ''
+      properties:
+        coupon:
+          description: The ID of the coupon to be offered.
+          maxLength: 5000
+          type: string
+      required:
+        - coupon
+      title: PortalFlowsCouponOffer
+      type: object
+      x-expandableFields: []
     portal_flows_flow:
       description: ''
       properties:
@@ -27132,6 +27144,11 @@ components:
     portal_flows_flow_subscription_cancel:
       description: ''
       properties:
+        retention:
+          anyOf:
+            - $ref: '#/components/schemas/portal_flows_retention'
+          description: Specify a retention strategy to be used in the cancellation flow.
+          nullable: true
         subscription:
           description: The ID of the subscription to be canceled.
           maxLength: 5000
@@ -27140,7 +27157,8 @@ components:
         - subscription
       title: PortalFlowsFlowSubscriptionCancel
       type: object
-      x-expandableFields: []
+      x-expandableFields:
+        - retention
     portal_flows_flow_subscription_update:
       description: ''
       properties:
@@ -27186,6 +27204,25 @@ components:
       x-expandableFields:
         - discounts
         - items
+    portal_flows_retention:
+      description: ''
+      properties:
+        coupon_offer:
+          anyOf:
+            - $ref: '#/components/schemas/portal_flows_coupon_offer'
+          description: Configuration when `retention.type=coupon_offer`.
+          nullable: true
+        type:
+          description: Type of retention strategy that will be used.
+          enum:
+            - coupon_offer
+          type: string
+      required:
+        - type
+      title: PortalFlowsRetention
+      type: object
+      x-expandableFields:
+        - coupon_offer
     portal_flows_subscription_update_confirm_discount:
       description: ''
       properties:
@@ -47833,6 +47870,26 @@ paths:
                       type: object
                     subscription_cancel:
                       properties:
+                        retention:
+                          properties:
+                            coupon_offer:
+                              properties:
+                                coupon:
+                                  maxLength: 5000
+                                  type: string
+                              required:
+                                - coupon
+                              title: coupon_offer_param
+                              type: object
+                            type:
+                              enum:
+                                - coupon_offer
+                              type: string
+                          required:
+                            - coupon_offer
+                            - type
+                          title: retention_param
+                          type: object
                         subscription:
                           maxLength: 5000
                           type: string