Credits
Check your organisation's remaining interview credit balance.
Returns the current credit balance for your organisation. One credit is consumed per completed interview, regardless of length.
Endpoint
Returns the current credit balance and trial credit balance for the authenticated organisation.
Authentication
x-api-key headerHeaders
| Name | Type | Description |
|---|---|---|
x-api-key | string | — |
Responses
| Field | Type | Description |
|---|---|---|
balancerequired | string | — |
trial_creditsrequired | integer | Trial Credits |
Example request
GET /v1/credits
curl "https://external-api.prod.insightscompany.io/v1/credits" \
-H "x-api-key: <api_key>"Example response
Response 200
{
"balance": "$50.00",
"trial_credits": 10
}Notes
- Credits are shared across all projects within your organisation.
- An interview that fails before completion does not consume a credit.
- Contact your Persona account manager to top up your balance or head to the dashboard and topup using stripe checkout.