List Plans
Get all plans for your account:Create Plan
Create a new usage plan:Create Plan Parameters
string
required
The name of the plan
string
A description of the plan
number
required
Maximum number of requests allowed per period
string
required
The period for the request limit (day, week, month, year)
array
Array of features included in this plan
object
Additional metadata for the plan
Get Plan
Retrieve a specific plan by ID:Update Plan
Update an existing plan:Update Plan Parameters
string
New name for the plan
string
Updated description for the plan
number
Updated maximum number of requests
string
Updated request period
array
Updated array of features
object
Updated metadata for the plan
Delete Plan
Delete a plan (soft delete):Get Plan Usage
Get usage statistics for a specific plan:Plan Usage Response
number
Total number of users on this plan
number
Total requests made by users on this plan
number
Average usage per user on this plan
string
The current period
Get Plan Users
Get all users on a specific plan:Complete Example
Plan Object
The plan object contains the following properties:string
Unique identifier for the plan
string
The name of the plan
string
The description of the plan
number
Maximum number of requests allowed per period
string
The period for the request limit
array
Array of features included in this plan
string
When the plan was created (ISO 8601 format)
string
When the plan was last updated (ISO 8601 format)
object
Additional metadata for the plan
Common Plan Features
Here are some common features you might include in your plans:api_access- Basic API accessbasic_analytics- Basic usage analyticsadvanced_analytics- Advanced analytics and reportingpriority_support- Priority customer supportwebhooks- Webhook notificationsemail_support- Email supportphone_support- Phone supportcustom_domains- Custom domain supportteam_management- Team and user management features
Next Steps
- Users - Manage user accounts and usage
- API Key Management - Generate and manage API keys
- Request Validation - Validate user requests

