Update OpenAPI specification

stripe · Feb 26, 2024 · 1755e1a · 1755e1a
1 parent fcf83ae
commit 1755e1a
Show file tree

Hide file tree

Showing 6 changed files with 171 additions and 0 deletions.
diff --git a/openapi/spec3.beta.sdk.json b/openapi/spec3.beta.sdk.json
@@ -101431,6 +101431,11 @@
                     ],
                     "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                   },
+                  "number": {
+                    "description": "Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically.",
+                    "maxLength": 26,
+                    "type": "string"
+                  },
                   "on_behalf_of": {
                     "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.",
                     "type": "string"
@@ -112167,6 +112172,10 @@
                   "explode": true,
                   "style": "deepObject"
                 },
+                "number": {
+                  "explode": true,
+                  "style": "deepObject"
+                },
                 "on_behalf_of": {
                   "explode": true,
                   "style": "deepObject"
@@ -112560,6 +112569,21 @@
                     ],
                     "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                   },
+                  "number": {
+                    "anyOf": [
+                      {
+                        "maxLength": 26,
+                        "type": "string"
+                      },
+                      {
+                        "enum": [
+                          ""
+                        ],
+                        "type": "string"
+                      }
+                    ],
+                    "description": "Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically."
+                  },
                   "on_behalf_of": {
                     "anyOf": [
                       {

diff --git a/openapi/spec3.beta.sdk.yaml b/openapi/spec3.beta.sdk.yaml
@@ -91596,6 +91596,19 @@ paths:
                     format. Individual keys can be unset by posting an empty
                     value to them. All keys can be unset by posting an empty
                     value to `metadata`.
+                number:
+                  description: >-
+                    Set the number for this invoice. If no number is present
+                    then a number will be assigned automatically when the
+                    invoice is finalized. In many markets, regulations require
+                    invoices to be unique, sequential and / or gapless. You are
+                    responsible for ensuring this is true across all your
+                    different invoicing systems in the event that you edit the
+                    invoice number using our API. If you use only Stripe for
+                    your invoices and do not change invoice numbers, Stripe
+                    handles this aspect of compliance for you automatically.
+                  maxLength: 26
+                  type: string
                 on_behalf_of:
                   description: >-
                     The account (if any) for which the funds of the invoice
@@ -102656,6 +102669,9 @@ paths:
               metadata:
                 explode: true
                 style: deepObject
+              number:
+                explode: true
+                style: deepObject
               on_behalf_of:
                 explode: true
                 style: deepObject
@@ -103016,6 +103032,23 @@ paths:
                     format. Individual keys can be unset by posting an empty
                     value to them. All keys can be unset by posting an empty
                     value to `metadata`.
+                number:
+                  anyOf:
+                    - maxLength: 26
+                      type: string
+                    - enum:
+                        - ''
+                      type: string
+                  description: >-
+                    Set the number for this invoice. If no number is present
+                    then a number will be assigned automatically when the
+                    invoice is finalized. In many markets, regulations require
+                    invoices to be unique, sequential and / or gapless. You are
+                    responsible for ensuring this is true across all your
+                    different invoicing systems in the event that you edit the
+                    invoice number using our API. If you use only Stripe for
+                    your invoices and do not change invoice numbers, Stripe
+                    handles this aspect of compliance for you automatically.
                 on_behalf_of:
                   anyOf:
                     - type: string

diff --git a/openapi/spec3.json b/openapi/spec3.json
@@ -79302,6 +79302,11 @@
                     ],
                     "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                   },
+                  "number": {
+                    "description": "Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically.",
+                    "maxLength": 26,
+                    "type": "string"
+                  },
                   "on_behalf_of": {
                     "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.",
                     "type": "string"
@@ -82228,6 +82233,10 @@
                   "explode": true,
                   "style": "deepObject"
                 },
+                "number": {
+                  "explode": true,
+                  "style": "deepObject"
+                },
                 "on_behalf_of": {
                   "explode": true,
                   "style": "deepObject"
@@ -82499,6 +82508,21 @@
                     ],
                     "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                   },
+                  "number": {
+                    "anyOf": [
+                      {
+                        "maxLength": 26,
+                        "type": "string"
+                      },
+                      {
+                        "enum": [
+                          ""
+                        ],
+                        "type": "string"
+                      }
+                    ],
+                    "description": "Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically."
+                  },
                   "on_behalf_of": {
                     "anyOf": [
                       {

diff --git a/openapi/spec3.sdk.json b/openapi/spec3.sdk.json
@@ -84003,6 +84003,11 @@
                     ],
                     "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                   },
+                  "number": {
+                    "description": "Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically.",
+                    "maxLength": 26,
+                    "type": "string"
+                  },
                   "on_behalf_of": {
                     "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.",
                     "type": "string"
@@ -87182,6 +87187,10 @@
                   "explode": true,
                   "style": "deepObject"
                 },
+                "number": {
+                  "explode": true,
+                  "style": "deepObject"
+                },
                 "on_behalf_of": {
                   "explode": true,
                   "style": "deepObject"
@@ -87467,6 +87476,21 @@
                     ],
                     "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                   },
+                  "number": {
+                    "anyOf": [
+                      {
+                        "maxLength": 26,
+                        "type": "string"
+                      },
+                      {
+                        "enum": [
+                          ""
+                        ],
+                        "type": "string"
+                      }
+                    ],
+                    "description": "Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically."
+                  },
                   "on_behalf_of": {
                     "anyOf": [
                       {

diff --git a/openapi/spec3.sdk.yaml b/openapi/spec3.sdk.yaml
@@ -76636,6 +76636,19 @@ paths:
                     format. Individual keys can be unset by posting an empty
                     value to them. All keys can be unset by posting an empty
                     value to `metadata`.
+                number:
+                  description: >-
+                    Set the number for this invoice. If no number is present
+                    then a number will be assigned automatically when the
+                    invoice is finalized. In many markets, regulations require
+                    invoices to be unique, sequential and / or gapless. You are
+                    responsible for ensuring this is true across all your
+                    different invoicing systems in the event that you edit the
+                    invoice number using our API. If you use only Stripe for
+                    your invoices and do not change invoice numbers, Stripe
+                    handles this aspect of compliance for you automatically.
+                  maxLength: 26
+                  type: string
                 on_behalf_of:
                   description: >-
                     The account (if any) for which the funds of the invoice
@@ -79706,6 +79719,9 @@ paths:
               metadata:
                 explode: true
                 style: deepObject
+              number:
+                explode: true
+                style: deepObject
               on_behalf_of:
                 explode: true
                 style: deepObject
@@ -79972,6 +79988,23 @@ paths:
                     format. Individual keys can be unset by posting an empty
                     value to them. All keys can be unset by posting an empty
                     value to `metadata`.
+                number:
+                  anyOf:
+                    - maxLength: 26
+                      type: string
+                    - enum:
+                        - ''
+                      type: string
+                  description: >-
+                    Set the number for this invoice. If no number is present
+                    then a number will be assigned automatically when the
+                    invoice is finalized. In many markets, regulations require
+                    invoices to be unique, sequential and / or gapless. You are
+                    responsible for ensuring this is true across all your
+                    different invoicing systems in the event that you edit the
+                    invoice number using our API. If you use only Stripe for
+                    your invoices and do not change invoice numbers, Stripe
+                    handles this aspect of compliance for you automatically.
                 on_behalf_of:
                   anyOf:
                     - type: string

diff --git a/openapi/spec3.yaml b/openapi/spec3.yaml
@@ -69615,6 +69615,19 @@ paths:
                     format. Individual keys can be unset by posting an empty
                     value to them. All keys can be unset by posting an empty
                     value to `metadata`.
+                number:
+                  description: >-
+                    Set the number for this invoice. If no number is present
+                    then a number will be assigned automatically when the
+                    invoice is finalized. In many markets, regulations require
+                    invoices to be unique, sequential and / or gapless. You are
+                    responsible for ensuring this is true across all your
+                    different invoicing systems in the event that you edit the
+                    invoice number using our API. If you use only Stripe for
+                    your invoices and do not change invoice numbers, Stripe
+                    handles this aspect of compliance for you automatically.
+                  maxLength: 26
+                  type: string
                 on_behalf_of:
                   description: >-
                     The account (if any) for which the funds of the invoice
@@ -71894,6 +71907,9 @@ paths:
               metadata:
                 explode: true
                 style: deepObject
+              number:
+                explode: true
+                style: deepObject
               on_behalf_of:
                 explode: true
                 style: deepObject
@@ -72126,6 +72142,23 @@ paths:
                     format. Individual keys can be unset by posting an empty
                     value to them. All keys can be unset by posting an empty
                     value to `metadata`.
+                number:
+                  anyOf:
+                    - maxLength: 26
+                      type: string
+                    - enum:
+                        - ''
+                      type: string
+                  description: >-
+                    Set the number for this invoice. If no number is present
+                    then a number will be assigned automatically when the
+                    invoice is finalized. In many markets, regulations require
+                    invoices to be unique, sequential and / or gapless. You are
+                    responsible for ensuring this is true across all your
+                    different invoicing systems in the event that you edit the
+                    invoice number using our API. If you use only Stripe for
+                    your invoices and do not change invoice numbers, Stripe
+                    handles this aspect of compliance for you automatically.
                 on_behalf_of:
                   anyOf:
                     - type: string