Breaking changes
Several account fields have been refactored to better describe legal entity, verification status and requirements, and configurable settings Breaking changes
What’s new
Includes multiple changes:
- Replaces the legal _ entity property on the Account API resource with individual , company , and business _ type .
- Replaces the verification hash with a requirements hash.
- Replaces the verification[fields _ needed] array with three arrays to better represent when information is required: requirements[eventually _ due] , requirements[currently _ due] , and requirements[past _ due] .
- Renames verification[due _ by] to requirements[current _ deadline] .
- Renames the disabled _ reason enum value of fields _ needed to requirements. past _ due .
- Moves properties on the Account object that configure behavior within Stripe into the new settings hash.
- Moves the payout _ schedule , payout _ statement _ descriptor and debit _ negative _ balances fields to settings[payouts] , renaming them to schedule , statement _ descriptor and debit _ negative _ balances .
- Moves the statement _ descriptor field to settings[payments][statement _ descriptor] .
- Moves decline _ charge _ on fields to settings[card _ payments] , renaming it to decline _ on .
- Moves the business _ logo , business _ logo _ large and business _ primary _ color fields to settings[branding] , renaming them to icon , logo and primary _ color . Additionally, the icon field requires the image file you upload to be a square.
- Moves the display _ name and timezone fields to settings[dashboard] .
Impact
This change significantly restructures the Account API resource, providing a more structured and detailed approach to account information and settings. You need to extensively update your code that interacts with the Account API.
Changes
| Parameters | Change | Resources or endpoints |
|---|---|---|
| legal_entity | Changed | Account |
| verification[fields_needed] verification[due_by] | Changed | Account |
| payout_schedule payout_statement_descriptor debit_negative_balances statement_descriptor decline_charge_on business_logo business_logo_large business_primary_color display_name timezone | Changed | Account |
Upgrade
- View your current API version in Workbench.
- If you use an SDK, upgrade to the corresponding SDK version for this API version.
- If you don’t use an SDK, update your API requests to include Stripe-Version: 2019-02-19
- Upgrade the API version used for webhook endpoints .
- Test your integration against the new version.
- If you use Connect, test your Connect integration .
- In Workbench, perform the upgrade . You can roll back the version for 72 hours.
Learn more about Stripe API upgrades.