Skip to main content
GET
/
v1
/
credits
Get Credits Balance
curl --request GET \
  --url https://api.sociavault.com/v1/credits \
  --header 'X-API-Key: <api-key>'
{
  "credits": 950,
  "subscriptionStatus": "active",
  "subscriptionId": "sub_1234567890"
}
Returns the current credit balance and subscription status for the authenticated user.

Authorizations

​
X-API-Key
string
header
required

API key for authentication. Format: sk_live_xxxxxxxxxxxxx

Get your API key from the Dashboard.

Response

Successful response

​
credits
integer
required

Remaining credits available

Example:

950

​
subscriptionStatus
enum<string>
required

Current subscription status

Available options:
active,
inactive,
cancelled,
past_due
Example:

"active"

​
subscriptionId
string | null

Subscription ID if active

Example:

"sub_1234567890"