Account
GEThttps://www.viso.li/api/account
Returns the plan this API key is entitled to, how many links were created this calendar month, and whether the next create will be rejected for hitting the limit.
plan.type is the entitled plan. A lapsed paid subscription is reported as FREE.
Send Authorization: Bearer sk_api_your_api_key on every request. See authentication.
Example request
1curl https://www.viso.li/api/account \
2 -H "Authorization: Bearer sk_api_your_api_key"
Success response
Returns 200 OK.
response.json
1{
2 "plan": {
3 "type": "PRO",
4 "period": "MONTHLY"
5 },
6 "links": {
7 "used": 12,
8 "limit": 500,
9 "limitReached": false
10 }
11}
Response fields
| Field | Type | Description |
|---|---|---|
plan.type | string | Required. FREE, STARTER, PRO, or ENTERPRISE. A lapsed paid subscription is reported as FREE. |
plan.period | string | Required. MONTHLY or YEARLY. |
links.used | number | Required. Links created during the current calendar month. |
links.limit | number | Required. Monthly link allowance for the entitled plan. |
links.limitReached | boolean | Required. True when used is at or above the monthly limit. |
Errors
| Status | Error | Description |
|---|---|---|
| 401 | Unauthorized | Missing, malformed, or invalid Bearer token. |
| 429 | Too Many Requests | More than 10 requests per minute and 50 requests per day. Some responses include a Retry-After header. |
| 500 | Internal Server Error | Unexpected server error. Retry the request. |