Manage organisation sandboxes
Manage your sandboxes for your organisation in the Dashboard.
You can use organisation sandboxes for many common development needs. You can create an organisation sandbox to:
- Test your integration across multiple sandboxes in an organisation sandbox and try Stripe Organisations features, such as customer and payment method sharing .
- Mirror your live organisation to test and stage changes to your integration before going live or deploying changes to production.
- Provide a development environment for each member of your team .
- Support a specific team within your organisation.
Use the Stripe Dashboard to manage your organisation sandbox. To test an organisation, create an organisation sandbox from the live organisation. Manage user access to organisation sandboxes at the live organisation.
After you create both sandboxes linked to your live account and organisation sandboxes, your overall account structure might look like this:
Create an organisation sandbox
If you have the Sandbox Administrator, Administrator, Developer, or Sandbox User role assigned in your live organisation, you can create a new organisation sandbox.
To create a sandbox:
- In your organisation Dashboard, click the account picker, then click Switch to sandbox > Create sandbox .
- Choose how to set up your organisation sandbox:
- Copy organisation and accounts : Creates an organisation sandbox that mirrors your live organisation structure, including sandboxes for each live account with all corresponding settings and capabilities. This option is the default.
- Use sandboxes from accounts : Moves existing sandboxes from your accounts into the new organisation sandbox. Some sandboxes might not be eligible to move (for example, test mode workspaces or pre-activation accounts).
- Create all new sandboxes : Creates the organisation sandbox as an empty container with no preconfigured accounts.
- Enter a unique name that reflects the purpose of the organisation sandbox (for example, “Staging”, in the Name field).
- Configure account sandboxes based on your selection:
- Copy organisation and accounts : Choose whether to include sandboxes for all accounts in the organisation, or clear individual accounts to exclude their sandboxes.
- Use sandboxes from accounts : Select the existing sandboxes to move into the new organisation sandbox.
- Create all new sandboxes : You can optionally include blank account sandboxes with minimal sample data. Specify a business location and name for each account sandbox that you want to create in the blank organisation sandbox.
- Click Create sandbox .
Stripe automatically assigns the Super Administrator role to any user who creates a sandbox. This role allows them to carry out all operations within that particular sandbox.
View an organisation sandbox
If you have the Administrator or Sandbox Administrator role, you can view all sandboxes and organisation sandboxes in your live organisation. If you have a Developer role, you can only view the sandboxes and organisation sandboxes you’ve created.
- From your organisation Dashboard, click the account picker > Switch to sandbox > Manage sandboxes in the Dashboard.
- Click Open to enter the sandbox organisation.
Sandboxes that you create for each live account don’t appear when you’re in the live organisation. Only organisation sandboxes remain visible while you’re in the live organisation. The banner at the top of the Dashboard indicates that you’re in a sandbox. From this point, you can go to any other part of the Dashboard.
Update an organisation sandbox
Any member of your team with the Sandbox Administrator role assigned in your live organisation can update the name and details of any organisation sandbox. Members with the Developer role can only update the name and details of an organisation sandbox that they’ve created.
- From your organisation Dashboard, click the account picker > Switch to sandbox > then select an organisation sandbox.
- Click Settings in the top right corner.
- Update the name or additional details about your organisation sandbox (for example, the branding).
Delete an organisation sandbox
If you have the Administrator or Sandbox Administrator role, you can delete an organisation sandbox. Otherwise, only the organisation sandbox’s owner can delete it.
- From your organisation Dashboard, click the account picker > Switch to sandbox > Manage sandboxes in the Dashboard.
- Click the trash can icon associated with the organisation sandbox you want to delete.
- Confirm that you want to delete this organisation sandbox as this action can’t be undone. After deletion, we remove all data associated with the organisation sandbox and the sandboxes within it and revoke access.
Note
Deleting an organisation sandbox deletes all the data associated with the organisation sandbox and removes access for any other team members who had access to the organisation sandbox.