Update OpenAPI specification for beta

Author: stripe-openapi[bot]

openapi/spec3.beta.sdk.json

@@ -6472,9 +6472,11 @@
                 "$ref": "#/components/schemas/billing_bill_resource_invoice_item_parents_invoice_item_subscription_parent"
               }
             ],
+            "description": "Details about the subscription that generated this invoice item",
             "nullable": true
           },
           "type": {
+            "description": "The type of parent that generated this invoice item",
             "enum": [
               "subscription_details"
             ],
@@ -6500,10 +6502,12 @@
         "description": "",
         "properties": {
           "subscription": {
+            "description": "The subscription that generated this invoice item",
             "maxLength": 5000,
             "type": "string"
           },
           "subscription_item": {
+            "description": "The subscription item that generated this invoice item",
             "maxLength": 5000,
             "type": "string"
           }
@@ -6577,11 +6581,12 @@
         "description": "",
         "properties": {
           "invoice_item": {
+            "description": "The invoice item that generated this line item",
             "maxLength": 5000,
             "type": "string"
           },
           "proration": {
-            "description": "Whether this is a proration.",
+            "description": "Whether this is a proration",
             "type": "boolean"
           },
           "proration_details": {
@@ -6594,6 +6599,7 @@
             "nullable": true
           },
           "subscription": {
+            "description": "The subscription that the invoice item belongs to",
             "maxLength": 5000,
             "nullable": true,
             "type": "string"
@@ -6626,6 +6632,7 @@
                 "$ref": "#/components/schemas/billing_bill_resource_invoicing_lines_parents_invoice_line_item_invoice_item_parent"
               }
             ],
+            "description": "Details about the invoice item that generated this line item",
             "nullable": true
           },
           "subscription_item_details": {
@@ -6634,9 +6641,11 @@
                 "$ref": "#/components/schemas/billing_bill_resource_invoicing_lines_parents_invoice_line_item_subscription_item_parent"
               }
             ],
+            "description": "Details about the subscription item that generated this line item",
             "nullable": true
           },
           "type": {
+            "description": "The type of parent that generated this line item",
             "enum": [
               "invoice_item_details",
               "subscription_item_details"
@@ -6666,12 +6675,13 @@
         "description": "",
         "properties": {
           "invoice_item": {
+            "description": "The invoice item that generated this line item",
             "maxLength": 5000,
             "nullable": true,
             "type": "string"
           },
           "proration": {
-            "description": "Whether this is a proration.",
+            "description": "Whether this is a proration",
             "type": "boolean"
           },
           "proration_details": {
@@ -6684,10 +6694,12 @@
             "nullable": true
           },
           "subscription": {
+            "description": "The subscription that the subscription item belongs to",
             "maxLength": 5000,
             "type": "string"
           },
           "subscription_item": {
+            "description": "The subscription item that generated this line item",
             "maxLength": 5000,
             "type": "string"
           }
@@ -6721,6 +6733,7 @@
                 "$ref": "#/components/schemas/billing_bill_resource_invoicing_parents_invoice_quote_parent"
               }
             ],
+            "description": "Details about the quote that generated this invoice",
             "nullable": true
           },
           "subscription_details": {
@@ -6729,9 +6742,11 @@
                 "$ref": "#/components/schemas/billing_bill_resource_invoicing_parents_invoice_subscription_parent"
               }
             ],
+            "description": "Details about the subscription that generated this invoice",
             "nullable": true
           },
           "type": {
+            "description": "The type of parent that generated this invoice",
             "enum": [
               "quote_details",
               "subscription_details"
@@ -6761,11 +6776,13 @@
         "description": "",
         "properties": {
           "behavior": {
+            "description": "The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.",
             "maxLength": 5000,
             "nullable": true,
             "type": "string"
           },
           "resumes_at": {
+            "description": "The time after which the subscription will resume collecting payments.",
             "format": "unix-time",
             "nullable": true,
             "type": "integer"
@@ -6787,6 +6804,7 @@
         "description": "",
         "properties": {
           "quote": {
+            "description": "The quote that generated this invoice",
             "maxLength": 5000,
             "type": "string"
           }
@@ -6809,6 +6827,7 @@
               "maxLength": 500,
               "type": "string"
             },
+            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization.\n *Note: This attribute is populated only for invoices created on or after June 29, 2023.*",
             "nullable": true,
             "type": "object"
           },
@@ -6818,13 +6837,16 @@
                 "$ref": "#/components/schemas/billing_bill_resource_invoicing_parents_invoice_pause_collection"
               }
             ],
+            "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).",
             "nullable": true
           },
           "subscription": {
+            "description": "The subscription that generated this invoice",
             "maxLength": 5000,
             "type": "string"
           },
           "subscription_proration_date": {
+            "description": "Only set for upcoming invoices that preview prorations. The time used to calculate prorations.",
             "format": "unix-time",
             "type": "integer"
           }

openapi/spec3.beta.sdk.yaml

@@ -5981,8 +5981,10 @@ components:
           anyOf:
             - $ref: >-
                 #/components/schemas/billing_bill_resource_invoice_item_parents_invoice_item_subscription_parent
+          description: Details about the subscription that generated this invoice item
           nullable: true
         type:
+          description: The type of parent that generated this invoice item
           enum:
             - subscription_details
           type: string
@@ -6001,9 +6003,11 @@ components:
       description: ''
       properties:
         subscription:
+          description: The subscription that generated this invoice item
           maxLength: 5000
           type: string
         subscription_item:
+          description: The subscription item that generated this invoice item
           maxLength: 5000
           type: string
       required:
@@ -6059,10 +6063,11 @@ components:
       description: ''
       properties:
         invoice_item:
+          description: The invoice item that generated this line item
           maxLength: 5000
           type: string
         proration:
-          description: Whether this is a proration.
+          description: Whether this is a proration
           type: boolean
         proration_details:
           anyOf:
@@ -6071,6 +6076,7 @@ components:
           description: Additional details for proration line items
           nullable: true
         subscription:
+          description: The subscription that the invoice item belongs to
           maxLength: 5000
           nullable: true
           type: string
@@ -6095,13 +6101,16 @@ components:
           anyOf:
             - $ref: >-
                 #/components/schemas/billing_bill_resource_invoicing_lines_parents_invoice_line_item_invoice_item_parent
+          description: Details about the invoice item that generated this line item
           nullable: true
         subscription_item_details:
           anyOf:
             - $ref: >-
                 #/components/schemas/billing_bill_resource_invoicing_lines_parents_invoice_line_item_subscription_item_parent
+          description: Details about the subscription item that generated this line item
           nullable: true
         type:
+          description: The type of parent that generated this line item
           enum:
             - invoice_item_details
             - subscription_item_details
@@ -6124,11 +6133,12 @@ components:
       description: ''
       properties:
         invoice_item:
+          description: The invoice item that generated this line item
           maxLength: 5000
           nullable: true
           type: string
         proration:
-          description: Whether this is a proration.
+          description: Whether this is a proration
           type: boolean
         proration_details:
           anyOf:
@@ -6137,9 +6147,11 @@ components:
           description: Additional details for proration line items
           nullable: true
         subscription:
+          description: The subscription that the subscription item belongs to
           maxLength: 5000
           type: string
         subscription_item:
+          description: The subscription item that generated this line item
           maxLength: 5000
           type: string
       required:
@@ -6166,13 +6178,16 @@ components:
           anyOf:
             - $ref: >-
                 #/components/schemas/billing_bill_resource_invoicing_parents_invoice_quote_parent
+          description: Details about the quote that generated this invoice
           nullable: true
         subscription_details:
           anyOf:
             - $ref: >-
                 #/components/schemas/billing_bill_resource_invoicing_parents_invoice_subscription_parent
+          description: Details about the subscription that generated this invoice
           nullable: true
         type:
+          description: The type of parent that generated this invoice
           enum:
             - quote_details
             - subscription_details
@@ -6195,10 +6210,16 @@ components:
       description: ''
       properties:
         behavior:
+          description: >-
+            The payment collection behavior for this subscription while paused.
+            One of `keep_as_draft`, `mark_uncollectible`, or `void`.
           maxLength: 5000
           nullable: true
           type: string
         resumes_at:
+          description: >-
+            The time after which the subscription will resume collecting
+            payments.
           format: unix-time
           nullable: true
           type: integer
@@ -6215,6 +6236,7 @@ components:
       description: ''
       properties:
         quote:
+          description: The quote that generated this invoice
           maxLength: 5000
           type: string
       required:
@@ -6231,17 +6253,32 @@ components:
           additionalProperties:
             maxLength: 500
             type: string
+          description: >-
+            Set of [key-value pairs](https://stripe.com/docs/api/metadata)
+            defined as subscription metadata when an invoice is created. Becomes
+            an immutable snapshot of the subscription metadata at the time of
+            invoice finalization.
+             *Note: This attribute is populated only for invoices created on or after June 29, 2023.*
           nullable: true
           type: object
         pause_collection:
           anyOf:
             - $ref: >-
                 #/components/schemas/billing_bill_resource_invoicing_parents_invoice_pause_collection
+          description: >-
+            If specified, payment collection for this subscription will be
+            paused. Note that the subscription status will be unchanged and will
+            not be updated to `paused`. Learn more about [pausing
+            collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
           nullable: true
         subscription:
+          description: The subscription that generated this invoice
           maxLength: 5000
           type: string
         subscription_proration_date:
+          description: >-
+            Only set for upcoming invoices that preview prorations. The time
+            used to calculate prorations.
           format: unix-time
           type: integer
       required: