Reclassify a store as dormant

Takes one store out of service by moving it to the dormant tier. This is the only way to stop a store — there is no separate pause action. The endpoint cancels the current plan and the dormant plan starts immediately.

Path params

ParameterTypeRequiredNotes
storeIdintegerRequiredDigits only.

Auth

  • Bearer — partner token. The store must belong to an account underneath your own partner account.

Rate limit

  • No rate limit.

Body

  • None.

Behaviour

  • 200 with { store_id, tier: "dormant", plan_id, plan_start }.
  • 403 store out of scope / partner unresolvable · 404 store not found.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json