Update OpenAPI specification

stripe · Aug 1, 2024 · 2b48b95 · 2b48b95
1 parent b57b1ba
commit 2b48b95
Show file tree

Hide file tree

Showing 6 changed files with 95 additions and 90 deletions.
diff --git a/openapi/spec3.beta.sdk.json b/openapi/spec3.beta.sdk.json
@@ -60870,7 +60870,7 @@
             "type": "integer"
           },
           "cancel_at_period_end": {
-            "description": "If the subscription has been canceled with the `at_period_end` flag set to `true`, `cancel_at_period_end` on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.",
+            "description": "Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period.",
             "type": "boolean"
           },
           "canceled_at": {
@@ -112226,7 +112226,7 @@
                         "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period."
                       },
                       "cancel_at_period_end": {
-                        "description": "Boolean indicating whether this subscription should cancel at the end of the current period.",
+                        "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.",
                         "type": "boolean"
                       },
                       "cancel_now": {
@@ -115182,7 +115182,7 @@
             "style": "deepObject"
           },
           {
-            "description": "Boolean indicating whether this subscription should cancel at the end of the current period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.",
+            "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.",
             "in": "query",
             "name": "subscription_cancel_at_period_end",
             "required": false,
@@ -115267,7 +115267,7 @@
                   "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period."
                 },
                 "cancel_at_period_end": {
-                  "description": "Boolean indicating whether this subscription should cancel at the end of the current period.",
+                  "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.",
                   "type": "boolean"
                 },
                 "cancel_now": {
@@ -118485,7 +118485,7 @@
             "style": "deepObject"
           },
           {
-            "description": "Boolean indicating whether this subscription should cancel at the end of the current period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.",
+            "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.",
             "in": "query",
             "name": "subscription_cancel_at_period_end",
             "required": false,
@@ -118570,7 +118570,7 @@
                   "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period."
                 },
                 "cancel_at_period_end": {
-                  "description": "Boolean indicating whether this subscription should cancel at the end of the current period.",
+                  "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.",
                   "type": "boolean"
                 },
                 "cancel_now": {
@@ -186480,7 +186480,7 @@
                     "type": "integer"
                   },
                   "cancel_at_period_end": {
-                    "description": "Boolean indicating whether this subscription should cancel at the end of the current period.",
+                    "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.",
                     "type": "boolean"
                   },
                   "collection_method": {
@@ -188196,7 +188196,7 @@
                     "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period."
                   },
                   "cancel_at_period_end": {
-                    "description": "Boolean indicating whether this subscription should cancel at the end of the current period.",
+                    "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.",
                     "type": "boolean"
                   },
                   "cancellation_details": {

diff --git a/openapi/spec3.beta.sdk.yaml b/openapi/spec3.beta.sdk.yaml
@@ -55879,11 +55879,8 @@ components:
           type: integer
         cancel_at_period_end:
           description: >-
-            If the subscription has been canceled with the `at_period_end` flag
-            set to `true`, `cancel_at_period_end` on the subscription will be
-            true. You can use this attribute to determine whether a subscription
-            that has a status of active is scheduled to be canceled at the end
-            of the current period.
+            Whether this subscription will (if `status=active`) or did (if
+            `status=canceled`) cancel at the end of the current billing period.
           type: boolean
         canceled_at:
           description: >-
@@ -102759,8 +102756,9 @@ paths:
                         this will always cause a proration for that period.
                     cancel_at_period_end:
                       description: >-
-                        Boolean indicating whether this subscription should
-                        cancel at the end of the current period.
+                        Indicate whether this subscription should cancel at the
+                        end of the current period (`current_period_end`).
+                        Defaults to `false`.
                       type: boolean
                     cancel_now:
                       description: >-
@@ -105817,10 +105815,10 @@ paths:
                 type: string
           style: deepObject
         - description: >-
-            Boolean indicating whether this subscription should cancel at the
-            end of the current period. This field has been deprecated and will
-            be removed in a future API version. Use
-            `subscription_details.cancel_at_period_end` instead.
+            Indicate whether this subscription should cancel at the end of the
+            current period (`current_period_end`). Defaults to `false`. This
+            field has been deprecated and will be removed in a future API
+            version. Use `subscription_details.cancel_at_period_end` instead.
           in: query
           name: subscription_cancel_at_period_end
           required: false
@@ -105899,8 +105897,9 @@ paths:
                   always cause a proration for that period.
               cancel_at_period_end:
                 description: >-
-                  Boolean indicating whether this subscription should cancel at
-                  the end of the current period.
+                  Indicate whether this subscription should cancel at the end of
+                  the current period (`current_period_end`). Defaults to
+                  `false`.
                 type: boolean
               cancel_now:
                 description: >-
@@ -109213,10 +109212,10 @@ paths:
                 type: string
           style: deepObject
         - description: >-
-            Boolean indicating whether this subscription should cancel at the
-            end of the current period. This field has been deprecated and will
-            be removed in a future API version. Use
-            `subscription_details.cancel_at_period_end` instead.
+            Indicate whether this subscription should cancel at the end of the
+            current period (`current_period_end`). Defaults to `false`. This
+            field has been deprecated and will be removed in a future API
+            version. Use `subscription_details.cancel_at_period_end` instead.
           in: query
           name: subscription_cancel_at_period_end
           required: false
@@ -109295,8 +109294,9 @@ paths:
                   always cause a proration for that period.
               cancel_at_period_end:
                 description: >-
-                  Boolean indicating whether this subscription should cancel at
-                  the end of the current period.
+                  Indicate whether this subscription should cancel at the end of
+                  the current period (`current_period_end`). Defaults to
+                  `false`.
                 type: boolean
               cancel_now:
                 description: >-
@@ -178739,8 +178739,9 @@ paths:
                   type: integer
                 cancel_at_period_end:
                   description: >-
-                    Boolean indicating whether this subscription should cancel
-                    at the end of the current period.
+                    Indicate whether this subscription should cancel at the end
+                    of the current period (`current_period_end`). Defaults to
+                    `false`.
                   type: boolean
                 collection_method:
                   description: >-
@@ -180522,8 +180523,9 @@ paths:
                     will always cause a proration for that period.
                 cancel_at_period_end:
                   description: >-
-                    Boolean indicating whether this subscription should cancel
-                    at the end of the current period.
+                    Indicate whether this subscription should cancel at the end
+                    of the current period (`current_period_end`). Defaults to
+                    `false`.
                   type: boolean
                 cancellation_details:
                   description: Details about why this subscription was cancelled

diff --git a/openapi/spec3.json b/openapi/spec3.json
@@ -42225,7 +42225,7 @@
             "type": "integer"
           },
           "cancel_at_period_end": {
-            "description": "If the subscription has been canceled with the `at_period_end` flag set to `true`, `cancel_at_period_end` on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.",
+            "description": "Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period.",
             "type": "boolean"
           },
           "canceled_at": {
@@ -77447,7 +77447,7 @@
                     "type": "integer"
                   },
                   "cancel_at_period_end": {
-                    "description": "Boolean indicating whether this subscription should cancel at the end of the current period.",
+                    "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.",
                     "type": "boolean"
                   },
                   "collection_method": {
@@ -78692,7 +78692,7 @@
                     "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period."
                   },
                   "cancel_at_period_end": {
-                    "description": "Boolean indicating whether this subscription should cancel at the end of the current period.",
+                    "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.",
                     "type": "boolean"
                   },
                   "cancellation_details": {
@@ -89984,7 +89984,7 @@
             "style": "deepObject"
           },
           {
-            "description": "Boolean indicating whether this subscription should cancel at the end of the current period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.",
+            "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.",
             "in": "query",
             "name": "subscription_cancel_at_period_end",
             "required": false,
@@ -91838,7 +91838,7 @@
             "style": "deepObject"
           },
           {
-            "description": "Boolean indicating whether this subscription should cancel at the end of the current period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.",
+            "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.",
             "in": "query",
             "name": "subscription_cancel_at_period_end",
             "required": false,
@@ -140625,7 +140625,7 @@
                     "type": "integer"
                   },
                   "cancel_at_period_end": {
-                    "description": "Boolean indicating whether this subscription should cancel at the end of the current period.",
+                    "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.",
                     "type": "boolean"
                   },
                   "collection_method": {
@@ -142046,7 +142046,7 @@
                     "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period."
                   },
                   "cancel_at_period_end": {
-                    "description": "Boolean indicating whether this subscription should cancel at the end of the current period.",
+                    "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.",
                     "type": "boolean"
                   },
                   "cancellation_details": {