List API plans
List API plans
/v1/planscurl --request GET --max-time 35 \ --url 'https://pokepos-market-api.vercel.app/v1/plans'{ "plans": [ { "id": "starter", "name": "Starter", "monthlyRequests": 10000, "requestsPerMinute": 30, "activeKeys": 2, "description": "For prototypes and focused integrations.", "price": null, "availability": "request-access" }, { "id": "growth", "name": "Growth", "monthlyRequests": 100000, "requestsPerMinute": 120, "activeKeys": 10, "description": "For production apps and growing catalog workflows.", "price": null, "availability": "request-access" }, { "id": "scale", "name": "Scale", "monthlyRequests": 1000000, "requestsPerMinute": 600, "activeKeys": 50, "description": "For high-volume commerce and data operations.", "price": null, "availability": "request-access" } ]}Response object
List API plans The root schema is PlanList.
plansPlan[]requiredValue returned by the market data source.
Related objects
Expand a type to inspect its fields.
Plan8 fields
idstringrequiredOne of starter, growth, scale.
namestringrequiredDisplay name from the source catalog.
descriptionstringrequiredShort plan description.
monthlyRequestsintegerrequiredMonthly account request allowance.
requestsPerMinuteintegerrequiredPer-minute account request allowance.
activeKeysintegerrequiredMaximum active API keys on the plan.
pricenullrequiredPlan price; currently provided on request.
availabilitystringrequiredAlways request-access.
Status codes
List API plans
Use the method published for this route.
Request failed; preserve x-request-id for support.
Account access store is unavailable or misconfigured.
Source request exceeded its budget.
Errors use error.code and error.message. Keep x-request-id for tracing. Read the error code catalog and examples.
Response headers
x-request-idRequest ID for tracing and support.
x-planPlan for admitted account-backed requests.
x-ratelimit-limitAccount allowance per UTC minute.
x-ratelimit-remainingRemaining requests in the UTC minute.
x-monthly-limitAccount allowance per UTC month.
x-monthly-remainingRemaining requests in the UTC month.
Retry-AfterNonnegative seconds until retry is useful for quota, cooldown or admission failures.
Success, empty, partial, stale and error examples
200 · success
{
"plans": [
{
"id": "starter",
"name": "Starter",
"monthlyRequests": 10000,
"requestsPerMinute": 30,
"activeKeys": 2,
"description": "For prototypes and focused integrations.",
"price": null,
"availability": "request-access"
},
{
"id": "growth",
"name": "Growth",
"monthlyRequests": 100000,
"requestsPerMinute": 120,
"activeKeys": 10,
"description": "For production apps and growing catalog workflows.",
"price": null,
"availability": "request-access"
},
{
"id": "scale",
"name": "Scale",
"monthlyRequests": 1000000,
"requestsPerMinute": 600,
"activeKeys": 50,
"description": "For high-volume commerce and data operations.",
"price": null,
"availability": "request-access"
}
]
}405 · METHOD_NOT_ALLOWED
{
"error": {
"code": "METHOD_NOT_ALLOWED",
"message": "Use the method published for this route."
}
}500 · INTERNAL_ERROR
{
"error": {
"code": "INTERNAL_ERROR",
"message": "Request failed; preserve x-request-id for support."
}
}503 · ACCESS_STORE_UNAVAILABLE
{
"error": {
"code": "ACCESS_STORE_UNAVAILABLE",
"message": "Account access store is unavailable or misconfigured."
}
}503 · USAGE_UNAVAILABLE
{
"error": {
"code": "USAGE_UNAVAILABLE",
"message": "Usage diagnostics require account-backed mode."
}
}503 · SERVICE_BUSY
{
"error": {
"code": "SERVICE_BUSY",
"message": "Service admission capacity exhausted; use Retry-After."
}
}503 · ACCESS_BUSY
{
"error": {
"code": "ACCESS_BUSY",
"message": "Database authorization capacity exhausted; use Retry-After."
}
}503 · UPSTREAM_BUSY
{
"error": {
"code": "UPSTREAM_BUSY",
"message": "Source queue is full; use Retry-After."
}
}503 · OCR_BUSY
{
"error": {
"code": "OCR_BUSY",
"message": "Photo recognition queue is full; use Retry-After."
}
}503 · OCR_UNAVAILABLE
{
"error": {
"code": "OCR_UNAVAILABLE",
"message": "Photo recognition is unavailable."
}
}504 · UPSTREAM_TIMEOUT
{
"error": {
"code": "UPSTREAM_TIMEOUT",
"message": "Source request exceeded its budget."
}
}504 · OCR_TIMEOUT
{
"error": {
"code": "OCR_TIMEOUT",
"message": "Photo recognition exceeded its processing budget."
}
}504 · REQUEST_DEADLINE_EXCEEDED
{
"error": {
"code": "REQUEST_DEADLINE_EXCEEDED",
"message": "Total request deadline exceeded."
}
}