States and blockers
An agent should not parse a state machine. Read state and blockers, and follow next_action.
Account status
Section titled “Account status”GET /account returns status:
| Status | Meaning |
|---|---|
awaiting_payment |
No payment yet. |
active |
Running. |
past_due |
A payment failed. |
paused |
The client paused all production. |
stopped |
Closed. |
It also returns counting_locations, min_locations and max_locations. Read them; do not hard-code them.
Location state
Section titled “Location state”Each store has one state, the same one the app’s Network page shows:
| State | Meaning |
|---|---|
on_hold |
Added by API. Waits for CreatoRain to release it. |
awaiting_payment |
Waits for payment. |
needs_hours |
Has no bookable hours. |
full_this_month |
This month’s videos are paced. Waits for next month. |
accepting |
Open to creators. accepting: true. |
paused |
Paused by you. |
payment_failed |
Paused by a failed payment or a dispute. |
ended |
Ended. |
status is the plain lifecycle: active, paused or ended. held is true while the API hold stands.
Blockers
Section titled “Blockers”blockers lists why something cannot move yet.
- On a location create:
below_minimumwhilecounting_locationsis undermin_locations. - On an onboarding session:
live_key_requires_top_up,key_limit_reached,owner_changed.
next_action
Section titled “next_action”next_action names the one thing to do next, such as a top-up. Today it is null on the account until the features behind each state ship. Not live yet