Get subscription and plan limits

GET

https://api.smallest.ai/atoms/v1/user/subscription

Returns the organization’s current subscription: plan id, credit balance, renewal date, and the per-plan limits (agents, campaigns, numbers, daily and concurrent calls, knowledge-base sizes) plus the features map that gates capabilities like telephony, campaigns, and webhooks. Use it to check remaining credits or whether a feature is enabled before attempting an action.

Returns the organization's current subscription: plan id, credit balance, renewal date, and the per-plan `limits` (agents, campaigns, numbers, daily and concurrent calls, knowledge-base sizes) plus the `features` map that gates capabilities like telephony, campaigns, and webhooks. Use it to check remaining credits or whether a feature is enabled before attempting an action.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Response

Successful response

statusbooleanOptional

dataobjectOptional

The subscription record. Extra fields may be present.

Errors

401

Unauthorized Error

500

Internal Server Error

1	import requests
2
3	url = "https://api.smallest.ai/atoms/v1/user/subscription"
4
5	headers = {"Authorization": "Bearer <token>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"status": true,
3	"data": {
4	"_id": "string",
5	"organization": "string",
6	"planId": "string",
7	"totalCredits": 1.1,
8	"currentCredits": 1.1,
9	"renewalDate": "2024-01-15T09:30:00Z",
10	"subscriptionActive": true,
11	"onPremEnabled": true,
12	"limits": {
13	"agents": 1,
14	"campaigns": 1,
15	"numbers": 1,
16	"dailyCalls": 1,
17	"concurrentCalls": 1,
18	"knowledgeBaseItemLimit": 1,
19	"knowledgeBaseLimits": 1
20	},
21	"features": {}
22	}
23	}