Get the current organization's Agent simulation plan
The organization’s current plan subscription, or null when it has none (never started, canceled or expired). status is Stripe’s subscription status: active and trialing are paid up; past_due and unpaid mean a renewal is failing. trialAvailable is true when starting now would begin with a free first month: an organization’s first plan gets one, and staff can offer one to an organization that has had a plan before. trialEnd is when billing would start if the plan were started now, null when there is no free month. access says what the plan allows: active (trialing, active or past_due) runs studies and buys credits; none buys nothing, and runs a study only on credits added earlier, which outlive the plan (a year from purchase) while its plan credits expire with it.
Authorizations
API key created in the ZeroClick dashboard under Settings → API keys. Keys start with zc_. Send them as Authorization: Bearer zc_....
Response
Default Response
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$