Skip to content

Commit

Permalink
Update OpenAPI specification
Browse files Browse the repository at this point in the history
  • Loading branch information
@stripe-openapi
stripe-openapi[bot] committed Jan 19, 2024
1 parent 7ccc070 commit 60a3406
Show file tree
Hide file tree
Showing 6 changed files with 204 additions and 111 deletions.
28 changes: 14 additions & 14 deletions openapi/spec3.beta.sdk.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"components": {
"schemas": {
"account": {
"description": "This is an object representing a Stripe account. You can retrieve it to see\nproperties on the account like its current requirements or if the account is\nenabled to make live charges or receive payouts.\n\nFor Custom accounts, the properties below are always returned. For other accounts, some properties are returned until that\naccount has started to go through Connect Onboarding. Once you create an [Account Link](https://stripe.com/docs/api/account_links)\nfor a Standard or Express account, some parameters are no longer returned. These are marked as **Custom Only** or **Custom and Express**\nbelow. Learn about the differences [between accounts](https://stripe.com/docs/connect/accounts).",
"description": "This is an object representing a Stripe account. You can retrieve it to see\nproperties on the account like its current requirements or if the account is\nenabled to make live charges or receive payouts.\n\nFor Custom accounts, the properties below are always returned. For other accounts, some properties are returned until that\naccount has started to go through Connect Onboarding. Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions),\nsome properties are only returned for Custom accounts. Learn about the differences [between accounts](https://stripe.com/docs/connect/accounts).",
"properties": {
"business_profile": {
"anyOf": [
Expand All @@ -14,7 +14,7 @@
"nullable": true
},
"business_type": {
"description": "The business type.",
"description": "The business type. Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), this property is only returned for Custom accounts.",
"enum": [
"company",
"government_entity",
Expand Down Expand Up @@ -64,7 +64,7 @@
"type": "string"
},
"external_accounts": {
"description": "External accounts (bank accounts and debit cards) currently attached to this account",
"description": "External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where `controller[is_controller]` is true.",
"properties": {
"data": {
"description": "The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.",
Expand Down Expand Up @@ -68324,7 +68324,7 @@
"type": "object"
},
"business_type": {
"description": "The business type.",
"description": "The business type. Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), this property can only be updated for Custom accounts.",
"enum": [
"company",
"government_entity",
Expand Down Expand Up @@ -68760,7 +68760,7 @@
"type": "object"
},
"company": {
"description": "Information about the company or business. This field is available for any `business_type`.",
"description": "Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), this property can only be updated for Custom accounts.",
"properties": {
"address": {
"description": "The company's primary address.",
Expand Down Expand Up @@ -69203,13 +69203,13 @@
"type": "array"
},
"external_account": {
"description": "A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation. <br><br>By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](https://stripe.com/docs/api#account_create_bank_account) or [card creation](https://stripe.com/docs/api#account_create_card) APIs.",
"description": "A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation. <br><br>By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](https://stripe.com/docs/api#account_create_bank_account) or [card creation](https://stripe.com/docs/api#account_create_card) APIs.<br><br>Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), this property can only be updated for Custom accounts.",
"maxLength": 5000,
"type": "string",
"x-stripeBypassValidation": true
},
"individual": {
"description": "Information about the person represented by the account. This field is null unless `business_type` is set to `individual`.",
"description": "Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), this property can only be updated for Custom accounts.",
"properties": {
"address": {
"description": "The individual's primary address.",
Expand Down Expand Up @@ -69850,7 +69850,7 @@
"type": "object"
},
"tos_acceptance": {
"description": "Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance).",
"description": "Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance) This property can only be updated for Custom accounts.",
"properties": {
"date": {
"description": "The Unix timestamp marking when the account representative accepted their service agreement.",
Expand Down Expand Up @@ -70034,7 +70034,7 @@
}
},
"post": {
"description": "<p>Updates a <a href=\"/docs/connect/accounts\">connected account</a> by setting the values of the parameters passed. Any parameters not provided are\nleft unchanged.</p>\n\n<p>For Custom accounts, you can update any information on the account. For other accounts, you can update all information until that\naccount has started to go through Connect Onboarding. Once you create an <a href=\"/docs/api/account_links\">Account Link</a>\nfor a Standard or Express account, some parameters can no longer be changed. These are marked as <strong>Custom Only</strong> or <strong>Custom and Express</strong>\nbelow.</p>\n\n<p>To update your own account, use the <a href=\"https://dashboard.stripe.com/settings/account\">Dashboard</a>. Refer to our\n<a href=\"/docs/connect/updating-accounts\">Connect</a> documentation to learn more about updating accounts.</p>",
"description": "<p>Updates a <a href=\"/docs/connect/accounts\">connected account</a> by setting the values of the parameters passed. Any parameters not provided are\nleft unchanged.</p>\n\n<p>For Custom accounts, you can update any information on the account. For other accounts, you can update all information until that\naccount has started to go through Connect Onboarding. Once you create an <a href=\"/docs/api/account_links\">Account Link</a> or <a href=\"/docs/api/account_sessions\">Account Session</a>,\nsome properties can only be changed or updated for Custom accounts.</p>\n\n<p>To update your own account, use the <a href=\"https://dashboard.stripe.com/settings/account\">Dashboard</a>. Refer to our\n<a href=\"/docs/connect/updating-accounts\">Connect</a> documentation to learn more about updating accounts.</p>",
"operationId": "PostAccountsAccount",
"parameters": [
{
Expand Down Expand Up @@ -70203,7 +70203,7 @@
"type": "object"
},
"business_type": {
"description": "The business type.",
"description": "The business type. Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), this property can only be updated for Custom accounts.",
"enum": [
"company",
"government_entity",
Expand Down Expand Up @@ -70639,7 +70639,7 @@
"type": "object"
},
"company": {
"description": "Information about the company or business. This field is available for any `business_type`.",
"description": "Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), this property can only be updated for Custom accounts.",
"properties": {
"address": {
"description": "The company's primary address.",
Expand Down Expand Up @@ -71032,13 +71032,13 @@
"type": "array"
},
"external_account": {
"description": "A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation. <br><br>By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](https://stripe.com/docs/api#account_create_bank_account) or [card creation](https://stripe.com/docs/api#account_create_card) APIs.",
"description": "A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation. <br><br>By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](https://stripe.com/docs/api#account_create_bank_account) or [card creation](https://stripe.com/docs/api#account_create_card) APIs.<br><br>Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), this property can only be updated for Custom accounts.",
"maxLength": 5000,
"type": "string",
"x-stripeBypassValidation": true
},
"individual": {
"description": "Information about the person represented by the account. This field is null unless `business_type` is set to `individual`.",
"description": "Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), this property can only be updated for Custom accounts.",
"properties": {
"address": {
"description": "The individual's primary address.",
Expand Down Expand Up @@ -71679,7 +71679,7 @@
"type": "object"
},
"tos_acceptance": {
"description": "Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance).",
"description": "Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance) This property can only be updated for Custom accounts.",
"properties": {
"date": {
"description": "The Unix timestamp marking when the account representative accepted their service agreement.",
Expand Down
Loading

0 comments on commit 60a3406

Please sign in to comment.