Billing
Check the billing status and credit balances for your workspace.
Get billing overview
Returns the billing status and current credit balances for the workspace associated with your API key. Requires the read scope.
curl https://api.smoketest.sh/v1/billing \
-H "Authorization: Bearer $SMOKETEST_API_KEY"Sample response
{
"workspaceId": "018e1234-abcd-7000-8000-abc123456789",
"planKey": "smoketest",
"status": "active",
"cancelAtPeriodEnd": false,
"currentPeriodStart": "2026-06-01T00:00:00.000Z",
"currentPeriodEnd": "2026-07-01T00:00:00.000Z",
"trialEndsAt": "2026-07-01T00:00:00.000Z",
"subscriptionInterval": "month",
"balances": {
"trial": 0,
"subscription": 480,
"boost": 0,
"total": 480
},
"usage": {
"includedSubscriptionCredits": 500,
"dailyCreditsUsed": 20,
"dailyCreditCap": 100
}
}| Field | Type | Description |
|---|---|---|
workspaceId | UUID | Workspace this billing record belongs to |
planKey | string | Active plan identifier |
status | string | Subscription status — "trial", "active", "past_due", or "cancelled" |
cancelAtPeriodEnd | boolean | Whether the subscription is set to cancel at the end of the current period |
currentPeriodStart | ISO 8601 | null | Start of the current billing period |
currentPeriodEnd | ISO 8601 | null | End of the current billing period |
trialEndsAt | ISO 8601 | When the trial expires |
subscriptionInterval | "month" | "year" | null | Billing cadence |
balances.trial | integer | Credits remaining from the trial allowance |
balances.subscription | integer | Credits remaining from the subscription allowance |
balances.boost | integer | Credits from one-time boost purchases |
balances.total | integer | Total usable credits across all sources |
usage.includedSubscriptionCredits | integer | Credits included per billing period on the current plan |
usage.dailyCreditsUsed | integer | Credits consumed today |
usage.dailyCreditCap | integer | Maximum credits that can be used per day |