TidePay
Sandbox

Advance a sandbox subscription's test clock

POST
/sandbox/advance

Test-key only. Fast-forwards a sandbox subscription through up to 12 billing periods, running the renewal charge for each — the equivalent of Stripe's test clocks. Stops at the first cycle that does not settle, so a test wallet that forces a failure leaves the subscription past_due.

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/advance" \  -H "Content-Type: application/json" \  -d '{    "subscriptionId": "string"  }'
{  "cycles": [    "settled",    "settled",    "failed"  ],  "subscription": {    "id": "string",    "status": "string",    "currentPeriodEnd": "string"  }}