Skip to content

Commit

Permalink
Update OpenAPI specification
Browse files Browse the repository at this point in the history
  • Loading branch information
stripe-openapi[bot] committed Feb 28, 2024
1 parent 0aec3e4 commit df364b3
Show file tree
Hide file tree
Showing 2 changed files with 84 additions and 0 deletions.
35 changes: 35 additions & 0 deletions openapi/spec3.beta.sdk.json
Original file line number Diff line number Diff line change
Expand Up @@ -141909,6 +141909,14 @@
"expand": {
"explode": true,
"style": "deepObject"
},
"metadata": {
"explode": true,
"style": "deepObject"
},
"transfer_data": {
"explode": true,
"style": "deepObject"
}
},
"schema": {
Expand All @@ -141918,13 +141926,40 @@
"description": "The updated total amount that you intend to collect from the cardholder. This amount must be smaller than the currently authorized amount.",
"type": "integer"
},
"application_fee_amount": {
"description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
"type": "integer"
},
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 1000,
"type": "string"
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
"items": {
"maxLength": 5000,
"type": "string"
},
"type": "array"
},
"metadata": {
"additionalProperties": {
"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`.",
"type": "object"
},
"transfer_data": {
"description": "The parameters used to automatically create a transfer after the payment is captured.\nLearn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
"properties": {
"amount": {
"description": "The amount that will be transferred automatically when a charge succeeds.",
"type": "integer"
}
},
"title": "transfer_data_update_params",
"type": "object"
}
},
"required": [
Expand Down
49 changes: 49 additions & 0 deletions openapi/spec3.beta.sdk.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -134452,6 +134452,12 @@ paths:
expand:
explode: true
style: deepObject
metadata:
explode: true
style: deepObject
transfer_data:
explode: true
style: deepObject
schema:
additionalProperties: false
properties:
Expand All @@ -134461,12 +134467,55 @@ paths:
cardholder. This amount must be smaller than the currently
authorized amount.
type: integer
application_fee_amount:
description: >-
The amount of the application fee (if any) that will be
requested to be applied to the payment and transferred to
the application owner's Stripe account. The amount of the
application fee collected will be capped at the total
payment amount. For more information, see the PaymentIntents
[use case for connected
accounts](https://stripe.com/docs/payments/connected-accounts).
type: integer
description:
description: >-
An arbitrary string attached to the object. Often useful for
displaying to users.
maxLength: 1000
type: string
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
metadata:
additionalProperties:
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`.
type: object
transfer_data:
description: >-
The parameters used to automatically create a transfer after
the payment is captured.

Learn more about the [use case for connected
accounts](https://stripe.com/docs/payments/connected-accounts).
properties:
amount:
description: >-
The amount that will be transferred automatically when a
charge succeeds.
type: integer
title: transfer_data_update_params
type: object
required:
- amount
type: object
Expand Down

0 comments on commit df364b3

Please sign in to comment.