Skip to content

catalog.plans.list

The plans and the top up rate

GET/catalog/plans

Operation
catalog.plans.list
MCP tool
catalog_plans_list

The monthly plans and the top up rate, in SECONDS of finished video. Plans are monthly subscriptions: each paid month fills the plan time, which ends with the billing period. Top up time never expires. Prices are in US dollars. Buying is not part of this API: this read exists so an integration can tell a customer what a plan or a top up gives them.

curl 'https://api.gogoscreen.com/api/v1/catalog/plans' \
  -H "Authorization: Bearer $GOGOSCREEN_API_KEY"
A request to this operation.
json
{
  "plans": [
    {
      "id": "plan_starter",
      "seconds": 900,
      "priceUsd": 29,
      "rank": 1,
      "name": "Starter",
      "interval": "month"
    },
    {
      "id": "plan_pro",
      "seconds": 2700,
      "priceUsd": 79,
      "rank": 2,
      "name": "Pro",
      "interval": "month"
    },
    {
      "id": "plan_business",
      "seconds": 7200,
      "priceUsd": 199,
      "rank": 3,
      "name": "Business",
      "interval": "month"
    }
  ],
  "payg": {
    "minUsd": 10,
    "maxUsd": 4999,
    "secondsPerUsd": 29,
    "presetsUsd": [
      10,
      20,
      50,
      100
    ]
  },
  "planMonths": 1,
  "freeSecondsOnSignup": 60
}
200 response, captured from a real call. Ids, timestamps and signed URLs are replaced; the shape is untouched.

At a glance

FactDetail
Scopescatalog:read
Credentialsa signed in dashboard session or an API key.
Rate limit600 requests a minute per credential, in the read class.
IdempotencyNot applicable. This operation changes nothing.
MCP toolcatalog_plans_list
Always setsCache-Control: public, max-age=300

Response

Answers 200. Every answer also carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset, and every error body carries a requestId.

200 OK

The plans and the top up rate

200 OK body
NameTypeDescription
freeSecondsOnSignupnumber
paygobjectThe top up rate: seconds per dollar, the minimum in whole dollars, and the preset amounts. Top up time never expires.any keys
planMonthsnumberHow long one paid period of plan time lasts, in months: 1 (plans renew monthly).
plansobject[]
idstring
intervalstringHow often the plan renews: month.
namestring
priceUsdnumber
ranknumber
secondsnumber
200 OK headers
HeaderMeaning
Cache-ControlAlways public, max-age=300.

Errors

Every refusal is { error: { code, message, details?, requestId } }. Branch on code, never on the sentence. The full catalogue is at Errors.

CodeStatusWhen it happensWhat to do
validation_failed400The merged path, query and body did not match the operation's schema. The schemas are strict, so an unknown field is a failure rather than something ignored, and a string carrying half of a character is refused before it can be stored.Read details.issues. Each entry carries a path, a message and a machine readable code. Fix every named field and send the request again; the same body always fails the same way.
unauthorized401No credential was presented, or the key is unknown, revoked or expired, or an X-API-Key header carried something that is not an API key. details.reason says which.Send Authorization: Bearer gsk_live_…. A revoked or expired key never starts working again, so issue a new one in the developer console. Put a dashboard session token in Authorization, never in X-API-Key.
forbidden_scope403The credential does not carry every scope the operation declares, or it is the wrong kind of credential for it. keys.* and assistant.* are user only and can never be called by a key.details.requiredScopes and details.missingScopes name what is missing. A key's scopes cannot be changed after it is issued, so create a new key with them. When details.allowedActors is present, no key can call this operation at all.
not_found404No resource of that id belongs to this account. A resource that belongs to somebody else answers 404 as well, never 403.Check the id. Do not treat this as a permissions problem.
rate_limited429The credential's per minute budget, the account's per minute ceiling, or a daily cap was exceeded. details.scope is minute, day or account, or global when the product's own daily cap on voice previews is spent.Wait the Retry-After seconds and retry. details.limit and details.resetAt say what was hit and when it reopens. The RateLimit-* headers on every answer let a client pace itself before it gets here.
internal_error500An unhandled failure inside this API. The original message is logged and never answered.Retry once, then quote requestId to support. A 5xx deletes the idempotency claim rather than storing it, so retrying under the same key is safe.