# Adds the Claimable Sandboxes API for platforms

## What’s new

Launches the [ClaimableSandbox](https://docs.stripe.com/api/v2/claimable-sandboxes/object.md?api-version=2026-11-18.endive) resource in API v2, enabling app-building platforms to programmatically create preconfigured Stripe sandboxes for their users. Each sandbox includes the platform’s Stripe App and an onboarding link that users can follow to claim the sandbox.

The API includes three endpoints:

- [Create a claimable sandbox](https://docs.stripe.com/api/v2/claimable-sandboxes/create.md?api-version=2026-11-18.endive): Provisions a sandbox and returns one-time API key tokens.
- [Retrieve a claimable sandbox](https://docs.stripe.com/api/v2/claimable-sandboxes/retrieve.md?api-version=2026-11-18.endive): Returns the current state of a sandbox. Pass `sandbox_details.api_keys` in the [include](https://docs.stripe.com/api/v2/claimable-sandboxes/retrieve.md?api-version=2026-11-18.endive#v2_retrieve_claimable_sandboxes-include) parameter to return API key descriptors.
- [Renew an onboarding link](https://docs.stripe.com/api/v2/claimable-sandboxes/renew-onboarding-link.md?api-version=2026-11-18.endive): Generates a fresh onboarding link after the previous one expires.

Each sandbox moves through the `unclaimed`, `claimed`, `live`, and `expired` statuses. Five event types track this lifecycle: `v2.core.claimable_sandbox.created`, `v2.core.claimable_sandbox.claimed`, `v2.core.claimable_sandbox.updated`, `v2.core.claimable_sandbox.expiring`, and `v2.core.claimable_sandbox.expired`.

When you create a sandbox, set the [channel](https://docs.stripe.com/api/v2/claimable-sandboxes/create.md?api-version=2026-11-18.endive#v2_create_claimable_sandboxes-channel) parameter to `public` for production use with a published Stripe App, or `testing` for prototyping.

## Impact

[Integrate the Claimable Sandboxes API](https://docs.stripe.com/sandboxes/claimable-sandboxes.md) to give your platform’s users a preconfigured Stripe sandbox without requiring them to sign up for Stripe first. Use it in coding tools, marketplace builders, and other platforms that onboard users to Stripe.

## Changes

#### REST API

|  | Change | Resource |
| --- | --- | --- |
|  | Added | [V2.Core.ClaimableSandbox](/api/v2/core/claimable-sandboxes/object?api-version=2026-11-18.endive#v2_claimable_sandbox_object) |

| Endpoints | Change | Resource |
| --- | --- | --- |
| `create`, `renew_onboarding_link`, `retrieve` | Added | [V2.Core.ClaimableSandbox](/api/v2/core/claimable-sandboxes/object?api-version=2026-11-18.endive#v2_claimable_sandbox_object) |

|  | Change | Event type |
| --- | --- | --- |
| `V2CoreClaimableSandboxClaimedEvent`, `V2CoreClaimableSandboxCreatedEvent`, `V2CoreClaimableSandboxExpiredEvent`, `V2CoreClaimableSandboxExpiringEvent`, `V2CoreClaimableSandboxUpdatedEvent` | Added | `V2.Core.ClaimableSandbox` |

| Codes | Change |  |
| --- | --- | --- |
| `claimable_sandbox_creation_rate_limit_exceeded`, `claimable_sandbox_testing_creation_rate_limit_exceeded` | Added | `rate_limit` |

#### Ruby

|  | Change | Resource |
| --- | --- | --- |
|  | Added | [V2::Core::ClaimableSandbox](/api/v2/core/claimable-sandboxes/object?api-version=2026-11-18.endive#v2_claimable_sandbox_object) |

| Methods | Change | Resource |
| --- | --- | --- |
| `create`, `renew_onboarding_link`, `retrieve` | Added | [V2::Core::ClaimableSandbox](/api/v2/core/claimable-sandboxes/object?api-version=2026-11-18.endive#v2_claimable_sandbox_object) |

|  | Change | Event type |
| --- | --- | --- |
| `V2CoreClaimableSandboxClaimedEvent`, `V2CoreClaimableSandboxCreatedEvent`, `V2CoreClaimableSandboxExpiredEvent`, `V2CoreClaimableSandboxExpiringEvent`, `V2CoreClaimableSandboxUpdatedEvent` | Added | `V2::Core::ClaimableSandbox` |

#### Python

|  | Change | Resource |
| --- | --- | --- |
|  | Added | [v2.core.ClaimableSandbox](/api/v2/core/claimable-sandboxes/object?api-version=2026-11-18.endive#v2_claimable_sandbox_object) |

| Methods | Change | Resource |
| --- | --- | --- |
| `create`, `renew_onboarding_link`, `retrieve` | Added | [v2.core.ClaimableSandbox](/api/v2/core/claimable-sandboxes/object?api-version=2026-11-18.endive#v2_claimable_sandbox_object) |

|  | Change | Event type |
| --- | --- | --- |
| `V2CoreClaimableSandboxClaimedEvent`, `V2CoreClaimableSandboxCreatedEvent`, `V2CoreClaimableSandboxExpiredEvent`, `V2CoreClaimableSandboxExpiringEvent`, `V2CoreClaimableSandboxUpdatedEvent` | Added | `v2.core.ClaimableSandbox` |

| Codes | Change |  |
| --- | --- | --- |
| `claimable_sandbox_creation_rate_limit_exceeded`, `claimable_sandbox_testing_creation_rate_limit_exceeded` | Added | `RateLimitError` |

#### PHP

|  | Change | Resource |
| --- | --- | --- |
|  | Added | [V2.Core.ClaimableSandbox](/api/v2/core/claimable-sandboxes/object?api-version=2026-11-18.endive#v2_claimable_sandbox_object) |

| Methods | Change | Resource |
| --- | --- | --- |
| `create`, `renew_onboarding_link`, `retrieve` | Added | [V2.Core.ClaimableSandbox](/api/v2/core/claimable-sandboxes/object?api-version=2026-11-18.endive#v2_claimable_sandbox_object) |

|  | Change | Event type |
| --- | --- | --- |
| `V2CoreClaimableSandboxClaimedEvent`, `V2CoreClaimableSandboxCreatedEvent`, `V2CoreClaimableSandboxExpiredEvent`, `V2CoreClaimableSandboxExpiringEvent`, `V2CoreClaimableSandboxUpdatedEvent` | Added | `V2.Core.ClaimableSandbox` |

#### Java

|  | Change | Resource |
| --- | --- | --- |
|  | Added | [v2.core.ClaimableSandbox](/api/v2/core/claimable-sandboxes/object?api-version=2026-11-18.endive#v2_claimable_sandbox_object) |

| Methods | Change | Resource |
| --- | --- | --- |
| `create`, `renew_onboarding_link`, `retrieve` | Added | [v2.core.ClaimableSandbox](/api/v2/core/claimable-sandboxes/object?api-version=2026-11-18.endive#v2_claimable_sandbox_object) |

|  | Change | Event type |
| --- | --- | --- |
| `V2CoreClaimableSandboxClaimedEvent`, `V2CoreClaimableSandboxCreatedEvent`, `V2CoreClaimableSandboxExpiredEvent`, `V2CoreClaimableSandboxExpiringEvent`, `V2CoreClaimableSandboxUpdatedEvent` | Added | `v2.core.ClaimableSandbox` |

#### Node.js

|  | Change | Resource |
| --- | --- | --- |
|  | Added | [V2.Core.ClaimableSandbox](/api/v2/core/claimable-sandboxes/object?api-version=2026-11-18.endive#v2_claimable_sandbox_object) |

| Methods | Change | Resource |
| --- | --- | --- |
| `create`, `renew_onboarding_link`, `retrieve` | Added | [V2.Core.ClaimableSandbox](/api/v2/core/claimable-sandboxes/object?api-version=2026-11-18.endive#v2_claimable_sandbox_object) |

|  | Change | Event type |
| --- | --- | --- |
| `V2CoreClaimableSandboxClaimedEvent`, `V2CoreClaimableSandboxCreatedEvent`, `V2CoreClaimableSandboxExpiredEvent`, `V2CoreClaimableSandboxExpiringEvent`, `V2CoreClaimableSandboxUpdatedEvent` | Added | `V2.Core.ClaimableSandbox` |

| Codes | Change |  |
| --- | --- | --- |
| `claimable_sandbox_creation_rate_limit_exceeded`, `claimable_sandbox_testing_creation_rate_limit_exceeded` | Added | `RateLimitError` |

#### Go

|  | Change | Resource |
| --- | --- | --- |
|  | Added | [V2CoreClaimableSandbox](/api/v2/core/claimable-sandboxes/object?api-version=2026-11-18.endive#v2_claimable_sandbox_object) |

| Methods | Change | Resource |
| --- | --- | --- |
| `Get`, `New`, `RenewOnboardingLink` | Added | [V2CoreClaimableSandbox](/api/v2/core/claimable-sandboxes/object?api-version=2026-11-18.endive#v2_claimable_sandbox_object) |

|  | Change | Event type |
| --- | --- | --- |
| `V2CoreClaimableSandboxClaimedEvent`, `V2CoreClaimableSandboxCreatedEvent`, `V2CoreClaimableSandboxExpiredEvent`, `V2CoreClaimableSandboxExpiringEvent`, `V2CoreClaimableSandboxUpdatedEvent` | Added | `V2CoreClaimableSandbox` |

| Codes | Change |  |
| --- | --- | --- |
| `claimable_sandbox_creation_rate_limit_exceeded`, `claimable_sandbox_testing_creation_rate_limit_exceeded` | Added | `RateLimitError` |

#### .NET

|  | Change | Resource |
| --- | --- | --- |
|  | Added | [V2.Core.ClaimableSandbox](/api/v2/core/claimable-sandboxes/object?api-version=2026-11-18.endive#v2_claimable_sandbox_object) |

| Methods | Change | Resource |
| --- | --- | --- |
| `Create`, `Get`, `RenewOnboardingLink` | Added | [V2.Core.ClaimableSandbox](/api/v2/core/claimable-sandboxes/object?api-version=2026-11-18.endive#v2_claimable_sandbox_object) |

|  | Change | Event type |
| --- | --- | --- |
| `V2CoreClaimableSandboxClaimedEvent`, `V2CoreClaimableSandboxCreatedEvent`, `V2CoreClaimableSandboxExpiredEvent`, `V2CoreClaimableSandboxExpiringEvent`, `V2CoreClaimableSandboxUpdatedEvent` | Added | `V2.Core.ClaimableSandbox` |

## Upgrade

#### REST API

1. [View your current API version](https://docs.stripe.com/workbench/guides.md#view-api-versions) in Workbench.
2. 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](https://docs.stripe.com/api-versions.md#how-versions-are-specified-in-requests) to include `Stripe-Version: 2026-11-18.endive`
3. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
4. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
5. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### Ruby

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
2. Upgrade your Ruby SDK to [v21.1.0](https://github.com/stripe/stripe-ruby/releases/tag/v21.1.0)
3. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
4. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
5. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
6. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### Python

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
2. Upgrade your Python SDK to [v17.1.0](https://github.com/stripe/stripe-python/releases/tag/v17.1.0)
3. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
4. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
5. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
6. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### PHP

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
2. Upgrade your PHP SDK to [v23.1.0](https://github.com/stripe/stripe-php/releases/tag/v23.1.0)
3. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
4. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
5. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
6. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### Java

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
2. Upgrade your Java SDK to [v34.2.0](https://github.com/stripe/stripe-java/releases/tag/v34.2.0)
3. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
4. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
5. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
6. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### Node.js

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
2. Upgrade your Node SDK to [v23.2.0](https://github.com/stripe/stripe-node/releases/tag/v23.2.0)
3. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
4. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
5. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
6. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### Go

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
2. Upgrade your Go SDK to [v87.2.0](https://github.com/stripe/stripe-go/releases/tag/v87.2.0)
3. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
4. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
5. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
6. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### .NET

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
2. Upgrade your .NET SDK to [v53.2.0](https://github.com/stripe/stripe-dotnet/releases/tag/v53.2.0)
3. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
4. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
5. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
6. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).
