TidePay
Sandbox

Force-run a sandbox invoice cycle

POST
/sandbox/charge

Test-key only. Force-runs one invoice cycle right now instead of waiting for the cron.

X-API-Key<token>

Your merchant API key, shown once at creation in the dashboard (Settings → API key).

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/sandbox/charge" \  -H "Content-Type: application/json" \  -d '{    "subscriptionId": "string"  }'
{  "outcome": "settled"}