Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks
Sandboxes

Create a Claimable Sandbox v2

Create an anonymous, claimable sandbox. This sandbox can be prefilled with data. The response will include a claim URL that allow a user to claim the account.

Learn more about calling API v2 endpoints.

Parameters

  • enable_mcp_accessbooleanRequired

    If true, returns a key that can be used with Stripe’s MCP server.

  • prefillobjectRequired

    Values that are prefilled when a user claims the sandbox.

Returns

Response attributes

  • idstring

    Unique identifier for the Claimable sandbox.

  • objectstring, value is "v2.core.claimable_sandbox"

    String representing the object’s type. Objects of the same type share the same value of the object field.

  • api_keysobject

    Keys that can be used to set up an integration for this sandbox and operate on the account.

  • claim_urlstring

    URL for user to claim sandbox into their existing Stripe account.

  • createdtimestamp

    When the sandbox is created.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • prefillobject

    Values prefilled during the creation of the sandbox.

Error Codes
400max_claimable_sandboxes_created

When the maximum number of sandboxes has been created for a given platform.

POST /v2/core/claimable_sandboxes
curl -X POST https://api.stripe.com/v2/core/claimable_sandboxes \
  -H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2025-08-27.preview" \
  --json '{
    "prefill": {
        "email": "jenny.rosen@stripe.com",
        "name": "Jenny Sandbox",
        "country": "us"
    },
    "enable_mcp_access": "true"
  }'
Response
{
  "api_keys": {
    "mcp": "rk_test_51RzPFWRlMpFp5.....",
    "publishable": "pk_test_51RzPFWRlMpFp5.....",
    "secret": "sk_test_51RzPFWRlMpFp5....."
  },
  "claim_url": "https://dashboard.stripe.com/claim_sandbox/YWNjdF8xUnpQRldSb.....",
  "created": "2025-01-01T00:00:00.000Z",
  "id": "clmsbx_test_SvFlT3BhvSm2v1",
  "object": "v2.core.claimable_sandbox",
  "prefill": {
    "email": "jenny.rosen@stripe.com",
    "name": "Jenny Sandbox",
    "country": "us"
  },
  "livemode": false
}