Skip to main content
POST
Redeem a credit code

Authorizations

Authorization
string
header
required

API key with the vk_ prefix. Create one from the dashboard.

Body

application/json
code
string
required
workspace_id
string | null

The workspace to credit: its id (ws_...), its Clerk organization id (org_...), or your user id for your personal workspace. You must be a member. Omitted = the request's active workspace. The code is still redeemable once per person, whichever workspace is named.

Response

Code redeemed; credits added to balance

amount_usd
number<double>
required
balance_usd
number<double>
required