API Documentation
Build powerful integrations with FrostCP's comprehensive REST API. Complete documentation, code examples, and SDKs to get you started quickly.
200+
API Endpoints
50+
Webhook Events
1000/min
Rate Limit
99.9%
Uptime SLA
Getting Started
Everything you need to start building with the FrostCP API
Get API Key
Generate your API key from the FrostCP dashboard
Read Docs
Explore our comprehensive API documentation
Make Requests
Start making API calls with your favorite language
Go Live
Deploy your integration and start automating
API Endpoints
Core endpoints for managing clients, services, and billing
| Method | Endpoint | Description | Parameters |
|---|---|---|---|
| GET | /api/v1/clients | Retrieve all clients | limit, offset, search |
| POST | /api/v1/clients | Create a new client | name, email, company |
| GET | /api/v1/invoices | Retrieve invoices | client_id, status, date_range |
| POST | /api/v1/services | Provision a new service | client_id, product_id, billing_cycle |
Code Examples
Ready-to-use code examples to get you started quickly
Authentication
// Authentication using API key
const response = await fetch('https://api.frostcp.com/v1/clients', {
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
}
});
const clients = await response.json();Create Client
// Create a new client
const newClient = await fetch('https://api.frostcp.com/v1/clients', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'John Doe',
email: '[email protected]',
company: 'Example Corp'
})
});
const client = await newClient.json();Webhook Handler
// Handle FrostCP webhooks
app.post('/webhook/frostcp', (req, res) => {
const { event, data } = req.body;
switch(event) {
case 'invoice.paid':
console.log('Invoice paid:', data.invoice_id);
break;
case 'service.provisioned':
console.log('Service provisioned:', data.service_id);
break;
}
res.status(200).send('OK');
});SDKs & Libraries
Official SDKs and community libraries for popular programming languages
JavaScript/Node.js
Official
Python
Official
PHP
Official
Go
Community
Ruby
Community
C#/.NET
Coming Soon