Skip to content

Commit

Permalink
Update OpenAPI specification
Browse files Browse the repository at this point in the history
  • Loading branch information
@pakrym-stripe
pakrym-stripe committed Jul 6, 2022
1 parent b35a252 commit f43aea9
Show file tree
Hide file tree
Showing 6 changed files with 319 additions and 100 deletions.
52 changes: 46 additions & 6 deletions openapi/spec3.beta.sdk.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4773,7 +4773,7 @@
"additionalProperties": {
"type": "integer"
},
"description": "A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0.",
"description": "A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
"nullable": true,
"type": "object"
},
Expand Down Expand Up @@ -59478,6 +59478,17 @@
"description": "<p>Returns a list of Checkout Sessions.</p>",
"operationId": "GetCheckoutSessions",
"parameters": [
{
"description": "Only return the Checkout Sessions for the Customer specified.",
"in": "query",
"name": "customer",
"required": false,
"schema": {
"maxLength": 5000,
"type": "string"
},
"style": "form"
},
{
"description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
"in": "query",
Expand Down Expand Up @@ -63946,7 +63957,7 @@
"description": "Settings controlling the behavior of the customer's cash balance,\nsuch as reconciliation of funds received.",
"properties": {
"reconciliation_mode": {
"description": "Method for using the customer balance to pay outstanding\n`customer_balance` PaymentIntents. If set to `automatic`, all available\nfunds will automatically be used to pay any outstanding PaymentIntent.\nIf set to `manual`, only customer balance funds from bank transfers\nwith a reference code matching\n`payment_intent.next_action.display_bank_transfer_intructions.reference_code` will\nautomatically be used to pay the corresponding outstanding\nPaymentIntent.",
"description": "Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic` or `manual`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).",
"enum": [
"automatic",
"manual"
Expand Down Expand Up @@ -64715,7 +64726,7 @@
"description": "Settings controlling the behavior of the customer's cash balance,\nsuch as reconciliation of funds received.",
"properties": {
"reconciliation_mode": {
"description": "Method for using the customer balance to pay outstanding\n`customer_balance` PaymentIntents. If set to `automatic`, all available\nfunds will automatically be used to pay any outstanding PaymentIntent.\nIf set to `manual`, only customer balance funds from bank transfers\nwith a reference code matching\n`payment_intent.next_action.display_bank_transfer_intructions.reference_code` will\nautomatically be used to pay the corresponding outstanding\nPaymentIntent.",
"description": "Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic` or `manual`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).",
"enum": [
"automatic",
"manual"
Expand Down Expand Up @@ -65531,7 +65542,7 @@
}
},
"post": {
"description": "<p>Updates a customer’s cash balance.</p>",
"description": "<p>Changes the settings on a customer’s cash balance.</p>",
"operationId": "PostCustomersCustomerCashBalance",
"parameters": [
{
Expand Down Expand Up @@ -65570,9 +65581,10 @@
"type": "array"
},
"settings": {
"description": "A hash of settings for this cash balance.",
"properties": {
"reconciliation_mode": {
"description": "Method for using the customer balance to pay outstanding\n`customer_balance` PaymentIntents. If set to `automatic`, all available\nfunds will automatically be used to pay any outstanding PaymentIntent.\nIf set to `manual`, only customer balance funds from bank transfers\nwith a reference code matching\n`payment_intent.next_action.display_bank_transfer_intructions.reference_code` will\nautomatically be used to pay the corresponding outstanding\nPaymentIntent.",
"description": "Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic` or `manual`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).",
"enum": [
"automatic",
"manual"
Expand Down Expand Up @@ -95077,7 +95089,7 @@
}
},
"submit_type": {
"description": "Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button.",
"description": "Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).",
"enum": [
"auto",
"book",
Expand Down Expand Up @@ -104720,12 +104732,22 @@
"additionalProperties": false,
"properties": {
"amount": {
"description": "A positive integer representing how much to refund.",
"type": "integer"
},
"charge": {
"maxLength": 5000,
"type": "string"
},
"currency": {
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
"type": "string"
},
"customer": {
"description": "Customer whose customer balance to refund from.",
"maxLength": 5000,
"type": "string"
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
"items": {
Expand All @@ -104735,6 +104757,7 @@
"type": "array"
},
"instructions_email": {
"description": "Address to send refund email, use customer email if not specified",
"type": "string"
},
"metadata": {
Expand All @@ -104754,6 +104777,13 @@
],
"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`."
},
"origin": {
"description": "Origin of the refund",
"enum": [
"customer_balance"
],
"type": "string"
},
"payment_intent": {
"maxLength": 5000,
"type": "string"
Expand Down Expand Up @@ -130985,6 +131015,11 @@
"customer.tax_id.updated",
"customer.updated",
"file.created",
"financial_connections.account.created",
"financial_connections.account.deactivated",
"financial_connections.account.disconnected",
"financial_connections.account.reactivated",
"financial_connections.account.refreshed_balance",
"identity.verification_session.canceled",
"identity.verification_session.created",
"identity.verification_session.processing",
Expand Down Expand Up @@ -131446,6 +131481,11 @@
"customer.tax_id.updated",
"customer.updated",
"file.created",
"financial_connections.account.created",
"financial_connections.account.deactivated",
"financial_connections.account.disconnected",
"financial_connections.account.reactivated",
"financial_connections.account.refreshed_balance",
"identity.verification_session.canceled",
"identity.verification_session.created",
"identity.verification_session.processing",
Expand Down
86 changes: 54 additions & 32 deletions openapi/spec3.beta.sdk.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3975,7 +3975,7 @@ components:
type: integer
description: A hash of all cash balances available to this customer. You
cannot delete a customer with any cash balances, even if the balance is
0.
0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
nullable: true
type: object
customer:
Expand Down Expand Up @@ -48436,6 +48436,14 @@ paths:
description: "<p>Returns a list of Checkout Sessions.</p>"
operationId: GetCheckoutSessions
parameters:
- description: Only return the Checkout Sessions for the Customer specified.
in: query
name: customer
required: false
schema:
maxLength: 5000
type: string
style: form
- description: A cursor for use in pagination. `ending_before` is an object
ID that defines your place in the list. For instance, if you make a list
request and receive 100 objects, starting with `obj_bar`, your subsequent
Expand Down Expand Up @@ -52331,15 +52339,10 @@ paths:
such as reconciliation of funds received.
properties:
reconciliation_mode:
description: |-
Method for using the customer balance to pay outstanding
`customer_balance` PaymentIntents. If set to `automatic`, all available
funds will automatically be used to pay any outstanding PaymentIntent.
If set to `manual`, only customer balance funds from bank transfers
with a reference code matching
`payment_intent.next_action.display_bank_transfer_intructions.reference_code` will
automatically be used to pay the corresponding outstanding
PaymentIntent.
description: Controls how funds transferred by the customer
are applied to payment intents and invoices. Valid options
are `automatic` or `manual`. For more information about
these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
enum:
- automatic
- manual
Expand Down Expand Up @@ -52942,15 +52945,10 @@ paths:
such as reconciliation of funds received.
properties:
reconciliation_mode:
description: |-
Method for using the customer balance to pay outstanding
`customer_balance` PaymentIntents. If set to `automatic`, all available
funds will automatically be used to pay any outstanding PaymentIntent.
If set to `manual`, only customer balance funds from bank transfers
with a reference code matching
`payment_intent.next_action.display_bank_transfer_intructions.reference_code` will
automatically be used to pay the corresponding outstanding
PaymentIntent.
description: Controls how funds transferred by the customer
are applied to payment intents and invoices. Valid options
are `automatic` or `manual`. For more information about
these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
enum:
- automatic
- manual
Expand Down Expand Up @@ -53565,7 +53563,7 @@ paths:
"$ref": "#/components/schemas/error"
description: Error response.
post:
description: "<p>Updates a customer’s cash balance.</p>"
description: "<p>Changes the settings on a customer’s cash balance.</p>"
operationId: PostCustomersCustomerCashBalance
parameters:
- in: path
Expand Down Expand Up @@ -53595,17 +53593,13 @@ paths:
type: string
type: array
settings:
description: A hash of settings for this cash balance.
properties:
reconciliation_mode:
description: |-
Method for using the customer balance to pay outstanding
`customer_balance` PaymentIntents. If set to `automatic`, all available
funds will automatically be used to pay any outstanding PaymentIntent.
If set to `manual`, only customer balance funds from bank transfers
with a reference code matching
`payment_intent.next_action.display_bank_transfer_intructions.reference_code` will
automatically be used to pay the corresponding outstanding
PaymentIntent.
description: Controls how funds transferred by the customer
are applied to payment intents and invoices. Valid options
are `automatic` or `manual`. For more information about these
reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
enum:
- automatic
- manual
Expand Down Expand Up @@ -78602,9 +78596,11 @@ paths:
x-stripeParam:
containee_entity_name: shipping_option
submit_type:
description: Describes the type of transaction being performed in
order to customize relevant text on the page, such as the submit
button.
description: 'Describes the type of transaction being performed
in order to customize relevant text on the page, such as the submit
button. Changing this value will also affect the hostname in the
[url](https://stripe.com/docs/api/payment_links/payment_links/object#url)
property (example: `donate.stripe.com`).'
enum:
- auto
- book
Expand Down Expand Up @@ -86193,17 +86189,28 @@ paths:
additionalProperties: false
properties:
amount:
description: A positive integer representing how much to refund.
type: integer
charge:
maxLength: 5000
type: string
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
customer:
description: Customer whose customer balance to refund from.
maxLength: 5000
type: string
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
instructions_email:
description: Address to send refund email, use customer email if
not specified
type: string
metadata:
anyOf:
Expand All @@ -86218,6 +86225,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`.
origin:
description: Origin of the refund
enum:
- customer_balance
type: string
payment_intent:
maxLength: 5000
type: string
Expand Down Expand Up @@ -107095,6 +107107,11 @@ paths:
- customer.tax_id.updated
- customer.updated
- file.created
- financial_connections.account.created
- financial_connections.account.deactivated
- financial_connections.account.disconnected
- financial_connections.account.reactivated
- financial_connections.account.refreshed_balance
- identity.verification_session.canceled
- identity.verification_session.created
- identity.verification_session.processing
Expand Down Expand Up @@ -107479,6 +107496,11 @@ paths:
- customer.tax_id.updated
- customer.updated
- file.created
- financial_connections.account.created
- financial_connections.account.deactivated
- financial_connections.account.disconnected
- financial_connections.account.reactivated
- financial_connections.account.refreshed_balance
- identity.verification_session.canceled
- identity.verification_session.created
- identity.verification_session.processing
Expand Down
Loading

0 comments on commit f43aea9

Please sign in to comment.