Skip to main content
GET
Get the payer's plan, entitlements and limits
Returns the payer’s plan as it applies to this workspace: name and family, subscription state, every entitlement with enabled and reason, and limits (upload size, duration, copy targets, clone quota, price multipliers). It carries no billing-provider objects. When to use: before using a gated feature (lip-sync, on-screen, glossaries, subtitle downloads…) or to read upload limits. Plan changes and purchases happen only in the web app (manage_url). Side effects: None. Cost: Free. Idempotency: safe and pure (never writes); retry freely. Required scopes: account:read

Authorizations

Authorization
string
header
required

API key from Settings -> API keys, sent as Authorization: Bearer <key> (SDK environment variable RASK_API_KEY). Bound to one workspace and one acting user. Operations list the scopes they need (OpenAPI 3.1 scopes on a bearer scheme).

Scopes

account:read

Response

OK: Plan.

The payer's plan as it applies to this workspace.

object
enum<string>
required

Always plan.

Available options:
plan
payer
object
required

The payer of the workspace.

name
string
required

Plan name.

family
enum<string>
required

Plan family of the payer. Open enum: new values may be added.

  • trial: no subscription; trial processing window
  • free: free subscription
  • creator: Creator plans
  • creator_pro: Creator Pro plans
  • business: Business plans
  • enterprise: Enterprise plans
  • custom: any other plan
Available options:
trial,
free,
creator,
creator_pro,
business,
enterprise,
custom
subscription
object | null
required

Null on a trial.

entitlements
object[]
required

Plan features.

limits
object
required

Plan limits.

outputs_watermarked
boolean
required

Whether outputs carry a watermark.

manage_url
string<uri>
required

Web page where a human changes the plan or buys minutes (no API does).