Update OpenAPI specification

stripe · Jun 8, 2023 · 805d802 · 805d802
1 parent fe86be8
commit 805d802
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 51 deletions.
diff --git a/openapi/spec3.beta.sdk.json b/openapi/spec3.beta.sdk.json
@@ -15378,7 +15378,7 @@
         }
       },
       "invoice": {
-        "description": "Invoices are statements of amounts owed by a customer, and are either\ngenerated one-off, or generated periodically from a subscription.\n\nThey contain [invoice items](https://stripe.com/docs/api#invoiceitems), and proration adjustments\nthat may be caused by subscription upgrades/downgrades (if necessary).\n\nIf your invoice is configured to be billed through automatic charges,\nStripe automatically finalizes your invoice and attempts payment. Note\nthat finalizing the invoice,\n[when automatic](https://stripe.com/docs/billing/invoices/workflow/#auto_advance), does\nnot happen immediately as the invoice is created. Stripe waits\nuntil one hour after the last webhook was successfully sent (or the last\nwebhook timed out after failing). If you (and the platforms you may have\nconnected to) have no webhooks configured, Stripe waits one hour after\ncreation to finalize the invoice.\n\nIf your invoice is configured to be billed by sending an email, then based on your\n[email settings](https://dashboard.stripe.com/account/billing/automatic),\nStripe will email the invoice to your customer and await payment. These\nemails can contain a link to a hosted page to pay the invoice.\n\nStripe applies any customer credit on the account before determining the\namount due for the invoice (i.e., the amount that will be actually\ncharged). If the amount due for the invoice is less than Stripe's [minimum allowed charge\nper currency](/docs/currencies#minimum-and-maximum-charge-amounts), the\ninvoice is automatically marked paid, and we add the amount due to the\ncustomer's credit balance which is applied to the next invoice.\n\nMore details on the customer's credit balance are\n[here](https://stripe.com/docs/billing/customer/balance).\n\nRelated guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending)",
+        "description": "Invoices are statements of amounts owed by a customer, and are either\ngenerated one-off, or generated periodically from a subscription.\n\nThey contain [invoice items](https://stripe.com/docs/api#invoiceitems), and proration adjustments\nthat may be caused by subscription upgrades/downgrades (if necessary).\n\nIf your invoice is configured to be billed through automatic charges,\nStripe automatically finalizes your invoice and attempts payment. Note\nthat finalizing the invoice,\n[when automatic](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection), does\nnot happen immediately as the invoice is created. Stripe waits\nuntil one hour after the last webhook was successfully sent (or the last\nwebhook timed out after failing). If you (and the platforms you may have\nconnected to) have no webhooks configured, Stripe waits one hour after\ncreation to finalize the invoice.\n\nIf your invoice is configured to be billed by sending an email, then based on your\n[email settings](https://dashboard.stripe.com/account/billing/automatic),\nStripe will email the invoice to your customer and await payment. These\nemails can contain a link to a hosted page to pay the invoice.\n\nStripe applies any customer credit on the account before determining the\namount due for the invoice (i.e., the amount that will be actually\ncharged). If the amount due for the invoice is less than Stripe's [minimum allowed charge\nper currency](/docs/currencies#minimum-and-maximum-charge-amounts), the\ninvoice is automatically marked paid, and we add the amount due to the\ncustomer's credit balance which is applied to the next invoice.\n\nMore details on the customer's credit balance are\n[here](https://stripe.com/docs/billing/customer/balance).\n\nRelated guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending)",
         "properties": {
           "account_country": {
             "description": "The country of the business associated with this invoice, most often the business creating the invoice.",
@@ -15480,7 +15480,7 @@
             "type": "boolean"
           },
           "auto_advance": {
-            "description": "Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action.",
+            "description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.",
             "type": "boolean"
           },
           "automatic_tax": {
@@ -84660,7 +84660,7 @@
                     "type": "integer"
                   },
                   "auto_advance": {
-                    "description": "Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action.",
+                    "description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.",
                     "type": "boolean"
                   },
                   "automatic_tax": {
@@ -88243,7 +88243,7 @@
                     "type": "integer"
                   },
                   "auto_advance": {
-                    "description": "Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice.",
+                    "description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice.",
                     "type": "boolean"
                   },
                   "automatic_tax": {
@@ -89153,7 +89153,7 @@
                 "additionalProperties": false,
                 "properties": {
                   "auto_advance": {
-                    "description": "Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/invoicing/automatic-charging) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action.",
+                    "description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.",
                     "type": "boolean"
                   },
                   "expand": {

diff --git a/openapi/spec3.beta.sdk.yaml b/openapi/spec3.beta.sdk.yaml
@@ -14324,7 +14324,7 @@ components:
         that finalizing the invoice,
 
         [when
-        automatic](https://stripe.com/docs/billing/invoices/workflow/#auto_advance),
+        automatic](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection),
         does
 
         not happen immediately as the invoice is created. Stripe waits
@@ -14457,9 +14457,9 @@ components:
           type: boolean
         auto_advance:
           description: >-
-            Controls whether Stripe will perform [automatic
-            collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance)
-            of the invoice. When `false`, the invoice's state will not
+            Controls whether Stripe performs [automatic
+            collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection)
+            of the invoice. If `false`, the invoice's state doesn't
             automatically advance without an explicit action.
           type: boolean
         automatic_tax:
@@ -76801,9 +76801,9 @@ paths:
                   type: integer
                 auto_advance:
                   description: >-
-                    Controls whether Stripe will perform [automatic
-                    collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance)
-                    of the invoice. When `false`, the invoice's state will not
+                    Controls whether Stripe performs [automatic
+                    collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection)
+                    of the invoice. If `false`, the invoice's state doesn't
                     automatically advance without an explicit action.
                   type: boolean
                 automatic_tax:
@@ -80260,8 +80260,8 @@ paths:
                   type: integer
                 auto_advance:
                   description: >-
-                    Controls whether Stripe will perform [automatic
-                    collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance)
+                    Controls whether Stripe performs [automatic
+                    collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection)
                     of the invoice.
                   type: boolean
                 automatic_tax:
@@ -81140,9 +81140,9 @@ paths:
               properties:
                 auto_advance:
                   description: >-
-                    Controls whether Stripe will perform [automatic
-                    collection](https://stripe.com/docs/invoicing/automatic-charging)
-                    of the invoice. When `false`, the invoice's state will not
+                    Controls whether Stripe performs [automatic
+                    collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection)
+                    of the invoice. If `false`, the invoice's state doesn't
                     automatically advance without an explicit action.
                   type: boolean
                 expand:

diff --git a/openapi/spec3.json b/openapi/spec3.json
@@ -10929,7 +10929,7 @@
         "x-expandableFields": []
       },
       "invoice": {
-        "description": "Invoices are statements of amounts owed by a customer, and are either\ngenerated one-off, or generated periodically from a subscription.\n\nThey contain [invoice items](https://stripe.com/docs/api#invoiceitems), and proration adjustments\nthat may be caused by subscription upgrades/downgrades (if necessary).\n\nIf your invoice is configured to be billed through automatic charges,\nStripe automatically finalizes your invoice and attempts payment. Note\nthat finalizing the invoice,\n[when automatic](https://stripe.com/docs/billing/invoices/workflow/#auto_advance), does\nnot happen immediately as the invoice is created. Stripe waits\nuntil one hour after the last webhook was successfully sent (or the last\nwebhook timed out after failing). If you (and the platforms you may have\nconnected to) have no webhooks configured, Stripe waits one hour after\ncreation to finalize the invoice.\n\nIf your invoice is configured to be billed by sending an email, then based on your\n[email settings](https://dashboard.stripe.com/account/billing/automatic),\nStripe will email the invoice to your customer and await payment. These\nemails can contain a link to a hosted page to pay the invoice.\n\nStripe applies any customer credit on the account before determining the\namount due for the invoice (i.e., the amount that will be actually\ncharged). If the amount due for the invoice is less than Stripe's [minimum allowed charge\nper currency](/docs/currencies#minimum-and-maximum-charge-amounts), the\ninvoice is automatically marked paid, and we add the amount due to the\ncustomer's credit balance which is applied to the next invoice.\n\nMore details on the customer's credit balance are\n[here](https://stripe.com/docs/billing/customer/balance).\n\nRelated guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending)",
+        "description": "Invoices are statements of amounts owed by a customer, and are either\ngenerated one-off, or generated periodically from a subscription.\n\nThey contain [invoice items](https://stripe.com/docs/api#invoiceitems), and proration adjustments\nthat may be caused by subscription upgrades/downgrades (if necessary).\n\nIf your invoice is configured to be billed through automatic charges,\nStripe automatically finalizes your invoice and attempts payment. Note\nthat finalizing the invoice,\n[when automatic](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection), does\nnot happen immediately as the invoice is created. Stripe waits\nuntil one hour after the last webhook was successfully sent (or the last\nwebhook timed out after failing). If you (and the platforms you may have\nconnected to) have no webhooks configured, Stripe waits one hour after\ncreation to finalize the invoice.\n\nIf your invoice is configured to be billed by sending an email, then based on your\n[email settings](https://dashboard.stripe.com/account/billing/automatic),\nStripe will email the invoice to your customer and await payment. These\nemails can contain a link to a hosted page to pay the invoice.\n\nStripe applies any customer credit on the account before determining the\namount due for the invoice (i.e., the amount that will be actually\ncharged). If the amount due for the invoice is less than Stripe's [minimum allowed charge\nper currency](/docs/currencies#minimum-and-maximum-charge-amounts), the\ninvoice is automatically marked paid, and we add the amount due to the\ncustomer's credit balance which is applied to the next invoice.\n\nMore details on the customer's credit balance are\n[here](https://stripe.com/docs/billing/customer/balance).\n\nRelated guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending)",
         "properties": {
           "account_country": {
             "description": "The country of the business associated with this invoice, most often the business creating the invoice.",
@@ -11028,7 +11028,7 @@
             "type": "boolean"
           },
           "auto_advance": {
-            "description": "Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action.",
+            "description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.",
             "type": "boolean"
           },
           "automatic_tax": {
@@ -71464,7 +71464,7 @@
                     "type": "integer"
                   },
                   "auto_advance": {
-                    "description": "Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action.",
+                    "description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.",
                     "type": "boolean"
                   },
                   "automatic_tax": {
@@ -74386,7 +74386,7 @@
                     "type": "integer"
                   },
                   "auto_advance": {
-                    "description": "Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice.",
+                    "description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice.",
                     "type": "boolean"
                   },
                   "automatic_tax": {
@@ -75170,7 +75170,7 @@
                 "additionalProperties": false,
                 "properties": {
                   "auto_advance": {
-                    "description": "Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/invoicing/automatic-charging) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action.",
+                    "description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.",
                     "type": "boolean"
                   },
                   "expand": {