Update OpenAPI specification

stripe · Apr 19, 2024 · 675fdd7 · 675fdd7
1 parent 2be2ca6
commit 675fdd7
Show file tree

Hide file tree

Showing 6 changed files with 46 additions and 22 deletions.
diff --git a/openapi/spec3.beta.sdk.json b/openapi/spec3.beta.sdk.json
@@ -31250,7 +31250,7 @@
               "maxLength": 500,
               "type": "string"
             },
-            "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. Note that for line items with `type=subscription` this will reflect the metadata of the subscription that caused the line item to be created.",
+            "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. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.",
             "type": "object"
           },
           "object": {
@@ -117631,7 +117631,7 @@
                         "type": "string"
                       }
                     ],
-                    "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`."
+                    "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`. For `type=recurring` line items, the incoming metadata specified on the request is directly used to set this value, in contrast to `type=invoiceitem` line items, where any existing metadata on the invoice line is merged with the incoming data."
                   },
                   "period": {
                     "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.",
@@ -118522,7 +118522,7 @@
                         "type": "string"
                       }
                     ],
-                    "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`."
+                    "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`. For `type=recurring` line items, the incoming metadata specified on the request is directly used to set this value, in contrast to `type=invoiceitem` line items, where any existing metadata on the invoice line is merged with the incoming data."
                   },
                   "lines": {
                     "description": "The line items to update.",
@@ -118662,7 +118662,7 @@
                               "type": "string"
                             }
                           ],
-                          "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`."
+                          "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`. For `type=recurring` line items, the incoming metadata specified on the request is directly used to set this value, in contrast to `type=invoiceitem` line items, where any existing metadata on the invoice line is merged with the incoming data."
                         },
                         "period": {
                           "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.",

diff --git a/openapi/spec3.beta.sdk.yaml b/openapi/spec3.beta.sdk.yaml
@@ -28334,9 +28334,10 @@ components:
             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. Note
-            that for line items with `type=subscription` this will reflect the
-            metadata of the subscription that caused the line item to be
-            created.
+            that for line items with `type=subscription`, `metadata` reflects
+            the current metadata from the subscription associated with the line
+            item, unless the invoice line was directly updated with different
+            metadata after creation.
           type: object
         object:
           description: >-
@@ -107657,7 +107658,11 @@ paths:
                     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`.
+                    value to `metadata`. For `type=recurring` line items, the
+                    incoming metadata specified on the request is directly used
+                    to set this value, in contrast to `type=invoiceitem` line
+                    items, where any existing metadata on the invoice line is
+                    merged with the incoming data.
                 period:
                   description: >-
                     The period associated with this invoice item. When set to
@@ -108461,7 +108466,11 @@ paths:
                     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`.
+                    value to `metadata`. For `type=recurring` line items, the
+                    incoming metadata specified on the request is directly used
+                    to set this value, in contrast to `type=invoiceitem` line
+                    items, where any existing metadata on the invoice line is
+                    merged with the incoming data.
                 lines:
                   description: The line items to update.
                   items:
@@ -108600,7 +108609,12 @@ paths:
                           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`.
+                          by posting an empty value to `metadata`. For
+                          `type=recurring` line items, the incoming metadata
+                          specified on the request is directly used to set this
+                          value, in contrast to `type=invoiceitem` line items,
+                          where any existing metadata on the invoice line is
+                          merged with the incoming data.
                       period:
                         description: >-
                           The period associated with this invoice item. When set

diff --git a/openapi/spec3.json b/openapi/spec3.json
@@ -22342,7 +22342,7 @@
               "maxLength": 500,
               "type": "string"
             },
-            "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. Note that for line items with `type=subscription` this will reflect the metadata of the subscription that caused the line item to be created.",
+            "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. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.",
             "type": "object"
           },
           "object": {
@@ -91724,7 +91724,7 @@
                         "type": "string"
                       }
                     ],
-                    "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`."
+                    "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`. For `type=recurring` line items, the incoming metadata specified on the request is directly used to set this value, in contrast to `type=invoiceitem` line items, where any existing metadata on the invoice line is merged with the incoming data."
                   },
                   "period": {
                     "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.",

diff --git a/openapi/spec3.sdk.json b/openapi/spec3.sdk.json
@@ -27893,7 +27893,7 @@
               "maxLength": 500,
               "type": "string"
             },
-            "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. Note that for line items with `type=subscription` this will reflect the metadata of the subscription that caused the line item to be created.",
+            "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. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.",
             "type": "object"
           },
           "object": {
@@ -97496,7 +97496,7 @@
                         "type": "string"
                       }
                     ],
-                    "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`."
+                    "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`. For `type=recurring` line items, the incoming metadata specified on the request is directly used to set this value, in contrast to `type=invoiceitem` line items, where any existing metadata on the invoice line is merged with the incoming data."
                   },
                   "period": {
                     "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.",

diff --git a/openapi/spec3.sdk.yaml b/openapi/spec3.sdk.yaml
@@ -25395,9 +25395,10 @@ components:
             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. Note
-            that for line items with `type=subscription` this will reflect the
-            metadata of the subscription that caused the line item to be
-            created.
+            that for line items with `type=subscription`, `metadata` reflects
+            the current metadata from the subscription associated with the line
+            item, unless the invoice line was directly updated with different
+            metadata after creation.
           type: object
         object:
           description: >-
@@ -89570,7 +89571,11 @@ paths:
                     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`.
+                    value to `metadata`. For `type=recurring` line items, the
+                    incoming metadata specified on the request is directly used
+                    to set this value, in contrast to `type=invoiceitem` line
+                    items, where any existing metadata on the invoice line is
+                    merged with the incoming data.
                 period:
                   description: >-
                     The period associated with this invoice item. When set to

diff --git a/openapi/spec3.yaml b/openapi/spec3.yaml
@@ -21112,9 +21112,10 @@ components:
             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. Note
-            that for line items with `type=subscription` this will reflect the
-            metadata of the subscription that caused the line item to be
-            created.
+            that for line items with `type=subscription`, `metadata` reflects
+            the current metadata from the subscription associated with the line
+            item, unless the invoice line was directly updated with different
+            metadata after creation.
           type: object
         object:
           description: >-
@@ -79232,7 +79233,11 @@ paths:
                     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`.
+                    value to `metadata`. For `type=recurring` line items, the
+                    incoming metadata specified on the request is directly used
+                    to set this value, in contrast to `type=invoiceitem` line
+                    items, where any existing metadata on the invoice line is
+                    merged with the incoming data.
                 period:
                   description: >-
                     The period associated with this invoice item. When set to