Update OpenAPI specification

stripe · May 8, 2024 · beefe24 · beefe24
1 parent c5d3700
commit beefe24
Show file tree

Hide file tree

Showing 4 changed files with 136 additions and 0 deletions.
diff --git a/openapi/spec3.json b/openapi/spec3.json
@@ -85919,6 +85919,14 @@
                     ],
                     "description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details."
                   },
+                  "preview_mode": {
+                    "description": "Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.",
+                    "enum": [
+                      "next",
+                      "recurring"
+                    ],
+                    "type": "string"
+                  },
                   "schedule": {
                     "description": "The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.",
                     "maxLength": 5000,
@@ -87485,6 +87493,20 @@
             },
             "style": "deepObject"
           },
+          {
+            "description": "Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.",
+            "in": "query",
+            "name": "preview_mode",
+            "required": false,
+            "schema": {
+              "enum": [
+                "next",
+                "recurring"
+              ],
+              "type": "string"
+            },
+            "style": "form"
+          },
           {
             "description": "The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.",
             "in": "query",
@@ -89312,6 +89334,20 @@
             },
             "style": "deepObject"
           },
+          {
+            "description": "Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.",
+            "in": "query",
+            "name": "preview_mode",
+            "required": false,
+            "schema": {
+              "enum": [
+                "next",
+                "recurring"
+              ],
+              "type": "string"
+            },
+            "style": "form"
+          },
           {
             "description": "The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.",
             "in": "query",

diff --git a/openapi/spec3.sdk.json b/openapi/spec3.sdk.json
@@ -91080,6 +91080,14 @@
                     ],
                     "description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details."
                   },
+                  "preview_mode": {
+                    "description": "Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.",
+                    "enum": [
+                      "next",
+                      "recurring"
+                    ],
+                    "type": "string"
+                  },
                   "schedule": {
                     "description": "The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.",
                     "maxLength": 5000,
@@ -92828,6 +92836,20 @@
             },
             "style": "deepObject"
           },
+          {
+            "description": "Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.",
+            "in": "query",
+            "name": "preview_mode",
+            "required": false,
+            "schema": {
+              "enum": [
+                "next",
+                "recurring"
+              ],
+              "type": "string"
+            },
+            "style": "form"
+          },
           {
             "description": "The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.",
             "in": "query",
@@ -94873,6 +94895,20 @@
             },
             "style": "deepObject"
           },
+          {
+            "description": "Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.",
+            "in": "query",
+            "name": "preview_mode",
+            "required": false,
+            "schema": {
+              "enum": [
+                "next",
+                "recurring"
+              ],
+              "type": "string"
+            },
+            "style": "form"
+          },
           {
             "description": "The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.",
             "in": "query",

diff --git a/openapi/spec3.sdk.yaml b/openapi/spec3.sdk.yaml
@@ -83176,6 +83176,14 @@ paths:
                     account. See the [Invoices with
                     Connect](https://stripe.com/docs/billing/invoices/connect)
                     documentation for details.
+                preview_mode:
+                  description: >-
+                    Customizes the types of values to include when calculating
+                    the invoice. Defaults to `next` if unspecified.
+                  enum:
+                    - next
+                    - recurring
+                  type: string
                 schedule:
                   description: >-
                     The identifier of the schedule whose upcoming invoice you'd
@@ -85038,6 +85046,18 @@ paths:
                   - ''
                 type: string
           style: deepObject
+        - description: >-
+            Customizes the types of values to include when calculating the
+            invoice. Defaults to `next` if unspecified.
+          in: query
+          name: preview_mode
+          required: false
+          schema:
+            enum:
+              - next
+              - recurring
+            type: string
+          style: form
         - description: >-
             The identifier of the schedule whose upcoming invoice you'd like to
             retrieve. Cannot be used with subscription or subscription fields.
@@ -87143,6 +87163,18 @@ paths:
                   - ''
                 type: string
           style: deepObject
+        - description: >-
+            Customizes the types of values to include when calculating the
+            invoice. Defaults to `next` if unspecified.
+          in: query
+          name: preview_mode
+          required: false
+          schema:
+            enum:
+              - next
+              - recurring
+            type: string
+          style: form
         - description: >-
             The identifier of the schedule whose upcoming invoice you'd like to
             retrieve. Cannot be used with subscription or subscription fields.

diff --git a/openapi/spec3.yaml b/openapi/spec3.yaml
@@ -75240,6 +75240,14 @@ paths:
                     account. See the [Invoices with
                     Connect](https://stripe.com/docs/billing/invoices/connect)
                     documentation for details.
+                preview_mode:
+                  description: >-
+                    Customizes the types of values to include when calculating
+                    the invoice. Defaults to `next` if unspecified.
+                  enum:
+                    - next
+                    - recurring
+                  type: string
                 schedule:
                   description: >-
                     The identifier of the schedule whose upcoming invoice you'd
@@ -76374,6 +76382,18 @@ paths:
                   - ''
                 type: string
           style: deepObject
+        - description: >-
+            Customizes the types of values to include when calculating the
+            invoice. Defaults to `next` if unspecified.
+          in: query
+          name: preview_mode
+          required: false
+          schema:
+            enum:
+              - next
+              - recurring
+            type: string
+          style: form
         - description: >-
             The identifier of the schedule whose upcoming invoice you'd like to
             retrieve. Cannot be used with subscription or subscription fields.
@@ -77690,6 +77710,18 @@ paths:
                   - ''
                 type: string
           style: deepObject
+        - description: >-
+            Customizes the types of values to include when calculating the
+            invoice. Defaults to `next` if unspecified.
+          in: query
+          name: preview_mode
+          required: false
+          schema:
+            enum:
+              - next
+              - recurring
+            type: string
+          style: form
         - description: >-
             The identifier of the schedule whose upcoming invoice you'd like to
             retrieve. Cannot be used with subscription or subscription fields.