Update OpenAPI specification for beta

stripe · Nov 25, 2024 · 621b3a0 · 621b3a0
1 parent 04942a2
commit 621b3a0
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/openapi/spec3.beta.sdk.json b/openapi/spec3.beta.sdk.json
@@ -9398,7 +9398,7 @@
         }
       },
       "charge.refund.updated": {
-        "description": "Occurs whenever a refund is updated, on selected payment methods.",
+        "description": "Occurs whenever a refund is updated on selected payment methods. For updates on all refunds, listen to `refund.updated` instead.",
         "properties": {
           "object": {
             "$ref": "#/components/schemas/refund"
@@ -9414,7 +9414,7 @@
         }
       },
       "charge.refunded": {
-        "description": "Occurs whenever a charge is refunded, including partial refunds.",
+        "description": "Occurs whenever a charge is refunded, including partial refunds. Listen to `refund.created` for information about the refund.",
         "properties": {
           "object": {
             "$ref": "#/components/schemas/charge"

diff --git a/openapi/spec3.beta.sdk.yaml b/openapi/spec3.beta.sdk.yaml
@@ -8562,7 +8562,9 @@ components:
       x-stripeEvent:
         type: charge.pending
     charge.refund.updated:
-      description: 'Occurs whenever a refund is updated, on selected payment methods.'
+      description: >-
+        Occurs whenever a refund is updated on selected payment methods. For
+        updates on all refunds, listen to `refund.updated` instead.
       properties:
         object:
           $ref: '#/components/schemas/refund'
@@ -8573,7 +8575,9 @@ components:
       x-stripeEvent:
         type: charge.refund.updated
     charge.refunded:
-      description: 'Occurs whenever a charge is refunded, including partial refunds.'
+      description: >-
+        Occurs whenever a charge is refunded, including partial refunds. Listen
+        to `refund.created` for information about the refund.
       properties:
         object:
           $ref: '#/components/schemas/charge'