Get plan usage
BetaAPI v2 is in public beta: endpoints, fields and behaviour can change before general availability. See the changelog
GET
/account/plan_usage
const url = 'https://app.stoqapp.com/api/v2/external/account/plan_usage?period=string';const options = {method: 'GET', headers: {'X-Auth-Token': '<X-Auth-Token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://app.stoqapp.com/api/v2/external/account/plan_usage?period=string' \ --header 'X-Auth-Token: <X-Auth-Token>'The shop’s current STOQ plan and a billing month’s usage vs included limits, with the usage-based charges STOQ has metered.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”period
Example
stringResponses
Section titled “Responses”Success — the requested resource.
Media typeapplication/json
object
Example generated
{}Missing or invalid X-Auth-Token.
Media typeapplication/json
Error envelope returned by every failed request.
object
errors
required
Array<string>
Example
{ "errors": [ "Unauthorized" ]}The request failed validation.
Media typeapplication/json
Error envelope returned by every failed request.
object
errors
required
Array<string>
Example
{ "errors": [ "name is required" ]}Rate limited — cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.
Media typeapplication/json
Error envelope returned by every failed request.
object
errors
required
Array<string>
Example
{ "errors": [ "Rate limit exceeded" ]}Was this page helpful?
Thanks for letting us know.
Still stuck? Ask Quinn or chat with support