Skip to documentation
DOCUMENTATIONAPI referenceAccountList API plans
ACCOUNT / V1

List API plans

List API plans

GET/v1/plans
Public routeJSON response
Example requestv1
curl --request GET --max-time 35 \  --url 'https://pokepos-market-api.vercel.app/v1/plans'
Response illustrative JSON
{  "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"    }  ]}
Example values can change with the source.
RESPONSE

Response object

List API plans The root schema is PlanList.

plansPlan[]required

Value returned by the market data source.

SCHEMAS

Related objects

Expand a type to inspect its fields.

Plan8 fields
idstringrequired

One of starter, growth, scale.

namestringrequired

Display name from the source catalog.

descriptionstringrequired

Short plan description.

monthlyRequestsintegerrequired

Monthly account request allowance.

requestsPerMinuteintegerrequired

Per-minute account request allowance.

activeKeysintegerrequired

Maximum active API keys on the plan.

pricenullrequired

Plan price; currently provided on request.

availabilitystringrequired

Always request-access.

HTTP

Status codes

200

List API plans

405

Use the method published for this route.

500

Request failed; preserve x-request-id for support.

503

Account access store is unavailable or misconfigured.

504

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-id

Request ID for tracing and support.

x-plan

Plan for admitted account-backed requests.

x-ratelimit-limit

Account allowance per UTC minute.

x-ratelimit-remaining

Remaining requests in the UTC minute.

x-monthly-limit

Account allowance per UTC month.

x-monthly-remaining

Remaining requests in the UTC month.

Retry-After

Nonnegative 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."
  }
}