Store provisioning

Move stores between service tiers — as a bulk operation, or one store at a time.

Use these endpoints when a store's subscription changes: moving it up a tier, moving it down, taking it out of service, or bringing it back.

Prerequisites

• A partner bearer token. If the platform cannot resolve a partner account for your user, every endpoint here returns 403 Forbidden.
• The id of each store you want to move. You can only move stores belonging to accounts underneath your own partner account.

The tier field

Every endpoint takes a tier value. The accepted values are:

core · mgmt · plus · dormant

Ask your account manager which value corresponds to each of your subscriptions. Anything else returns 400.

What a tier change actually does

Each call cancels the store's current plan and starts the new one straight away.

There is no partial refund or partial charge for the unused part of the current period — the switch takes effect immediately at full price. Plan accordingly when moving a store mid-cycle.

To take a store out of service, move it to dormant. There is no separate "pause" action.

Choosing bulk or per-store

The two modes handle stores you do not own differently, and this catches people out:

• Bulk never fails on them. It returns two lists — provisioned for the stores it moved, and skipped_out_of_scope for ids it could not touch. Always read skipped_out_of_scope; an empty provisioned list with a 200 response means nothing moved.
• Per-store rejects them outright with 403 Forbidden.

Bulk is also safe to re-run. Sending the same list again moves nothing further, so a retry after a timeout neither double-charges nor duplicates anything.

Errors

Each endpoint page below carries its own request body, response example and full field list.

Endpoints