# Stripe Emulator (service host)

Create an instance:
curl -s -X POST https://stripe.emulators.dev/_emulate/instances
# Hosted deployments create instances lazily when the returned URL is first used. The instance URL is a capability: anyone who has it can read and modify the instance, so save the returned URLs. Never store real secrets in an emulator.
# The server generates an unguessable name. An optional {"instance":"<prefix>"} body adds a readable prefix.

Then use the returned providerBaseUrl / controlBaseUrl. Example below uses a sample instance.
# Stripe Emulator

Stateful Stripe payments emulator for customers, payment intents, charges, products, prices, checkout sessions, and webhooks.

Provider base URL: https://stripe.your-instance.emulators.dev
Control base URL: https://stripe.your-instance.emulators.dev/_emulate

Supported surfaces:
- REST API: partial at /
- Checkout redirect UI: supported at /checkout
- Webhooks: partial

Control endpoints:
- https://stripe.your-instance.emulators.dev/_emulate/manifest
- https://stripe.your-instance.emulators.dev/_emulate/coverage
- https://stripe.your-instance.emulators.dev/_emulate/connections
- https://stripe.your-instance.emulators.dev/_emulate/state
- https://stripe.your-instance.emulators.dev/_emulate/ledger
- https://stripe.your-instance.emulators.dev/_emulate/faults
- POST https://stripe.your-instance.emulators.dev/_emulate/credentials
- POST https://stripe.your-instance.emulators.dev/_emulate/seed
- POST https://stripe.your-instance.emulators.dev/_emulate/reset

Fault injection:
Arm a one-shot provider failure with a glob pathPattern, then inspect /ledger for faulted: true.
curl -s -X POST https://stripe.your-instance.emulators.dev/_emulate/faults \
  -H "content-type: application/json" \
  -d '{"match":{"method":"GET","pathPattern":"/v1/*"},"response":{"status":503,"body":{"error":"temporary"}}}'

Connect:

## Stripe SDK (TypeScript)
import Stripe from "stripe";

const url = new URL("https://stripe.your-instance.emulators.dev");
const stripe = new Stripe("<token>", {
  host: url.hostname,
  port: Number(url.port),
  protocol: url.protocol.replace(":", ""),
});

## Stripe env
STRIPE_API_BASE=https://stripe.your-instance.emulators.dev
STRIPE_SECRET_KEY=<token>

## curl
curl -s https://stripe.your-instance.emulators.dev/v1/customers -H "authorization: Bearer <token>"

## Base URL (env)
STRIPE_BASE_URL=https://stripe.your-instance.emulators.dev

## Create a credential
curl -s -X POST https://stripe.your-instance.emulators.dev/_emulate/credentials \
  -H "content-type: application/json" \
  -d '{"type":"api-key"}'

## Inspect requests
curl -s https://stripe.your-instance.emulators.dev/_emulate/ledger