Skip to main content
GET
/
api
/
v1
/
billing
/
state
Get Organization Billing
curl --request GET \
  --url https://api.skyvern.com/api/v1/billing/state
{
  "billing_id": "<string>",
  "organization_id": "<string>",
  "plan_tier": "free",
  "current_period_start": "2023-11-07T05:31:56Z",
  "current_period_end": "2023-11-07T05:31:56Z",
  "included_credits_this_period": 123,
  "credits_consumed_this_period": 123,
  "cached_credits_consumed_this_period": 123,
  "overage_enabled": true,
  "browser_uptime_seconds_consumed": 123,
  "topup_credits_total": 123,
  "topup_credits_used": 123,
  "topup_credits_remaining": 123,
  "credits_remaining": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z"
}

Headers

​
x-api-key
string | null

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

Response

Response Get Organization Billing Api V1 Billing State Get · object | null

Successful Response

​
billing_id
string
required
​
organization_id
string
required
​
plan_tier
enum<string>
required

Self-serve subscription tiers. Enterprise customers use manual billing (bypass).

Available options:
free,
hobby,
pro
​
current_period_start
string<date-time> | null
required
​
current_period_end
string<date-time> | null
required
​
included_credits_this_period
integer
required
​
credits_consumed_this_period
integer
required
​
cached_credits_consumed_this_period
integer
required
​
overage_enabled
boolean
required
​
browser_uptime_seconds_consumed
integer
required
​
topup_credits_total
integer
required
​
topup_credits_used
integer
required
​
topup_credits_remaining
integer
required
​
credits_remaining
integer
required
​
created_at
string<date-time>
required
​
modified_at
string<date-time>
required