Update OpenAPI specification

stripe · Jun 4, 2024 · 8de9a0b · 8de9a0b
1 parent 6c4714d
commit 8de9a0b
Show file tree

Hide file tree

Showing 6 changed files with 54 additions and 289 deletions.
diff --git a/openapi/spec3.beta.sdk.json b/openapi/spec3.beta.sdk.json
@@ -3600,9 +3600,6 @@
           {
             "$ref": "#/components/schemas/payout"
           },
-          {
-            "$ref": "#/components/schemas/platform_tax_fee"
-          },
           {
             "$ref": "#/components/schemas/refund"
           },
@@ -7655,7 +7652,7 @@
                 "$ref": "#/components/schemas/payment_intent"
               }
             ],
-            "description": "The ID of the PaymentIntent for Checkout Sessions in `payment` mode.",
+            "description": "The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.",
             "nullable": true,
             "x-expansionResources": {
               "oneOf": [
@@ -7771,7 +7768,7 @@
                 "$ref": "#/components/schemas/setup_intent"
               }
             ],
-            "description": "The ID of the SetupIntent for Checkout Sessions in `setup` mode.",
+            "description": "The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.",
             "nullable": true,
             "x-expansionResources": {
               "oneOf": [
@@ -47694,55 +47691,6 @@
         "type": "object",
         "x-expandableFields": []
       },
-      "platform_tax_fee": {
-        "description": "",
-        "properties": {
-          "account": {
-            "description": "The Connected account that incurred this charge.",
-            "maxLength": 5000,
-            "type": "string"
-          },
-          "id": {
-            "description": "Unique identifier for the object.",
-            "maxLength": 5000,
-            "type": "string"
-          },
-          "object": {
-            "description": "String representing the object's type. Objects of the same type share the same value.",
-            "enum": [
-              "platform_tax_fee"
-            ],
-            "type": "string"
-          },
-          "source_transaction": {
-            "description": "The payment object that caused this tax to be inflicted.",
-            "maxLength": 5000,
-            "type": "string"
-          },
-          "type": {
-            "description": "The type of tax (VAT).",
-            "maxLength": 5000,
-            "type": "string"
-          }
-        },
-        "required": [
-          "account",
-          "id",
-          "object",
-          "source_transaction",
-          "type"
-        ],
-        "title": "PlatformTax",
-        "type": "object",
-        "x-expandableFields": [],
-        "x-stripeResource": {
-          "class_name": "PlatformTaxFee",
-          "in_package": "",
-          "polymorphic_groups": [
-            "balance_transaction_source"
-          ]
-        }
-      },
       "portal_business_profile": {
         "description": "",
         "properties": {
@@ -173620,7 +173568,7 @@
     },
     "/v1/setup_intents/{intent}/cancel": {
       "post": {
-        "description": "<p>You can cancel a SetupIntent object when it’s in one of these statuses: <code>requires_payment_method</code>, <code>requires_confirmation</code>, or <code>requires_action</code>. </p>\n\n<p>After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error.</p>",
+        "description": "<p>You can cancel a SetupIntent object when it’s in one of these statuses: <code>requires_payment_method</code>, <code>requires_confirmation</code>, or <code>requires_action</code>. </p>\n\n<p>After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can’t cancel the SetupIntent for a Checkout Session. <a href=\"/docs/api/checkout/sessions/expire\">Expire the Checkout Session</a> instead.</p>",
         "operationId": "PostSetupIntentsIntentCancel",
         "parameters": [
           {

diff --git a/openapi/spec3.beta.sdk.yaml b/openapi/spec3.beta.sdk.yaml
@@ -3478,7 +3478,6 @@ components:
         - $ref: '#/components/schemas/issuing.dispute'
         - $ref: '#/components/schemas/issuing.transaction'
         - $ref: '#/components/schemas/payout'
-        - $ref: '#/components/schemas/platform_tax_fee'
         - $ref: '#/components/schemas/refund'
         - $ref: '#/components/schemas/reserve_transaction'
         - $ref: '#/components/schemas/tax_deducted_at_source'
@@ -7189,7 +7188,12 @@ components:
             - maxLength: 5000
               type: string
             - $ref: '#/components/schemas/payment_intent'
-          description: The ID of the PaymentIntent for Checkout Sessions in `payment` mode.
+          description: >-
+            The ID of the PaymentIntent for Checkout Sessions in `payment` mode.
+            You can't confirm or cancel the PaymentIntent for a Checkout
+            Session. To cancel, [expire the Checkout
+            Session](https://stripe.com/docs/api/checkout/sessions/expire)
+            instead.
           nullable: true
           x-expansionResources:
             oneOf:
@@ -7289,7 +7293,12 @@ components:
             - maxLength: 5000
               type: string
             - $ref: '#/components/schemas/setup_intent'
-          description: The ID of the SetupIntent for Checkout Sessions in `setup` mode.
+          description: >-
+            The ID of the SetupIntent for Checkout Sessions in `setup` mode. You
+            can't confirm or cancel the SetupIntent for a Checkout Session. To
+            cancel, [expire the Checkout
+            Session](https://stripe.com/docs/api/checkout/sessions/expire)
+            instead.
           nullable: true
           x-expansionResources:
             oneOf:
@@ -43872,46 +43881,6 @@ components:
       title: PlatformEarningFeeSource
       type: object
       x-expandableFields: []
-    platform_tax_fee:
-      description: ''
-      properties:
-        account:
-          description: The Connected account that incurred this charge.
-          maxLength: 5000
-          type: string
-        id:
-          description: Unique identifier for the object.
-          maxLength: 5000
-          type: string
-        object:
-          description: >-
-            String representing the object's type. Objects of the same type
-            share the same value.
-          enum:
-            - platform_tax_fee
-          type: string
-        source_transaction:
-          description: The payment object that caused this tax to be inflicted.
-          maxLength: 5000
-          type: string
-        type:
-          description: The type of tax (VAT).
-          maxLength: 5000
-          type: string
-      required:
-        - account
-        - id
-        - object
-        - source_transaction
-        - type
-      title: PlatformTax
-      type: object
-      x-expandableFields: []
-      x-stripeResource:
-        class_name: PlatformTaxFee
-        in_package: ''
-        polymorphic_groups:
-          - balance_transaction_source
     portal_business_profile:
       description: ''
       properties:
@@ -164704,7 +164673,9 @@ paths:
 
 
         <p>After you cancel it, setup is abandoned and any operations on the
-        SetupIntent fail with an error.</p>
+        SetupIntent fail with an error. You can’t cancel the SetupIntent for a
+        Checkout Session. <a href="/docs/api/checkout/sessions/expire">Expire
+        the Checkout Session</a> instead.</p>
       operationId: PostSetupIntentsIntentCancel
       parameters:
         - in: path

diff --git a/openapi/spec3.json b/openapi/spec3.json
@@ -2569,9 +2569,6 @@
               {
                 "$ref": "#/components/schemas/payout"
               },
-              {
-                "$ref": "#/components/schemas/platform_tax_fee"
-              },
               {
                 "$ref": "#/components/schemas/refund"
               },
@@ -2625,9 +2622,6 @@
                 {
                   "$ref": "#/components/schemas/payout"
                 },
-                {
-                  "$ref": "#/components/schemas/platform_tax_fee"
-                },
                 {
                   "$ref": "#/components/schemas/refund"
                 },
@@ -5199,7 +5193,7 @@
                 "$ref": "#/components/schemas/payment_intent"
               }
             ],
-            "description": "The ID of the PaymentIntent for Checkout Sessions in `payment` mode.",
+            "description": "The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.",
             "nullable": true,
             "x-expansionResources": {
               "oneOf": [
@@ -5315,7 +5309,7 @@
                 "$ref": "#/components/schemas/setup_intent"
               }
             ],
-            "description": "The ID of the SetupIntent for Checkout Sessions in `setup` mode.",
+            "description": "The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.",
             "nullable": true,
             "x-expansionResources": {
               "oneOf": [
@@ -34344,48 +34338,6 @@
         "type": "object",
         "x-expandableFields": []
       },
-      "platform_tax_fee": {
-        "description": "",
-        "properties": {
-          "account": {
-            "description": "The Connected account that incurred this charge.",
-            "maxLength": 5000,
-            "type": "string"
-          },
-          "id": {
-            "description": "Unique identifier for the object.",
-            "maxLength": 5000,
-            "type": "string"
-          },
-          "object": {
-            "description": "String representing the object's type. Objects of the same type share the same value.",
-            "enum": [
-              "platform_tax_fee"
-            ],
-            "type": "string"
-          },
-          "source_transaction": {
-            "description": "The payment object that caused this tax to be inflicted.",
-            "maxLength": 5000,
-            "type": "string"
-          },
-          "type": {
-            "description": "The type of tax (VAT).",
-            "maxLength": 5000,
-            "type": "string"
-          }
-        },
-        "required": [
-          "account",
-          "id",
-          "object",
-          "source_transaction",
-          "type"
-        ],
-        "title": "PlatformTax",
-        "type": "object",
-        "x-expandableFields": []
-      },
       "portal_business_profile": {
         "description": "",
         "properties": {
@@ -130725,7 +130677,7 @@
     },
     "/v1/setup_intents/{intent}/cancel": {
       "post": {
-        "description": "<p>You can cancel a SetupIntent object when it’s in one of these statuses: <code>requires_payment_method</code>, <code>requires_confirmation</code>, or <code>requires_action</code>. </p>\n\n<p>After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error.</p>",
+        "description": "<p>You can cancel a SetupIntent object when it’s in one of these statuses: <code>requires_payment_method</code>, <code>requires_confirmation</code>, or <code>requires_action</code>. </p>\n\n<p>After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can’t cancel the SetupIntent for a Checkout Session. <a href=\"/docs/api/checkout/sessions/expire\">Expire the Checkout Session</a> instead.</p>",
         "operationId": "PostSetupIntentsIntentCancel",
         "parameters": [
           {

diff --git a/openapi/spec3.sdk.json b/openapi/spec3.sdk.json
@@ -3339,9 +3339,6 @@
           {
             "$ref": "#/components/schemas/payout"
           },
-          {
-            "$ref": "#/components/schemas/platform_tax_fee"
-          },
           {
             "$ref": "#/components/schemas/refund"
           },
@@ -6603,7 +6600,7 @@
                 "$ref": "#/components/schemas/payment_intent"
               }
             ],
-            "description": "The ID of the PaymentIntent for Checkout Sessions in `payment` mode.",
+            "description": "The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.",
             "nullable": true,
             "x-expansionResources": {
               "oneOf": [
@@ -6719,7 +6716,7 @@
                 "$ref": "#/components/schemas/setup_intent"
               }
             ],
-            "description": "The ID of the SetupIntent for Checkout Sessions in `setup` mode.",
+            "description": "The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.",
             "nullable": true,
             "x-expansionResources": {
               "oneOf": [
@@ -41781,55 +41778,6 @@
         "type": "object",
         "x-expandableFields": []
       },
-      "platform_tax_fee": {
-        "description": "",
-        "properties": {
-          "account": {
-            "description": "The Connected account that incurred this charge.",
-            "maxLength": 5000,
-            "type": "string"
-          },
-          "id": {
-            "description": "Unique identifier for the object.",
-            "maxLength": 5000,
-            "type": "string"
-          },
-          "object": {
-            "description": "String representing the object's type. Objects of the same type share the same value.",
-            "enum": [
-              "platform_tax_fee"
-            ],
-            "type": "string"
-          },
-          "source_transaction": {
-            "description": "The payment object that caused this tax to be inflicted.",
-            "maxLength": 5000,
-            "type": "string"
-          },
-          "type": {
-            "description": "The type of tax (VAT).",
-            "maxLength": 5000,
-            "type": "string"
-          }
-        },
-        "required": [
-          "account",
-          "id",
-          "object",
-          "source_transaction",
-          "type"
-        ],
-        "title": "PlatformTax",
-        "type": "object",
-        "x-expandableFields": [],
-        "x-stripeResource": {
-          "class_name": "PlatformTaxFee",
-          "in_package": "",
-          "polymorphic_groups": [
-            "balance_transaction_source"
-          ]
-        }
-      },
       "portal_business_profile": {
         "description": "",
         "properties": {
@@ -137897,7 +137845,7 @@
     },
     "/v1/setup_intents/{intent}/cancel": {
       "post": {
-        "description": "<p>You can cancel a SetupIntent object when it’s in one of these statuses: <code>requires_payment_method</code>, <code>requires_confirmation</code>, or <code>requires_action</code>. </p>\n\n<p>After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error.</p>",
+        "description": "<p>You can cancel a SetupIntent object when it’s in one of these statuses: <code>requires_payment_method</code>, <code>requires_confirmation</code>, or <code>requires_action</code>. </p>\n\n<p>After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can’t cancel the SetupIntent for a Checkout Session. <a href=\"/docs/api/checkout/sessions/expire\">Expire the Checkout Session</a> instead.</p>",
         "operationId": "PostSetupIntentsIntentCancel",
         "parameters": [
           {