API Reference

Complete API documentation for VoltBee. Learn how to validate licenses, manage products, and handle webhooks.

Authentication

All API requests require an API key. Get yours from the dashboard.

app.js

                1const volt =
                new VoltBee('vb_key_...')
              

License Validation

volt.validate(key: string): Promise<LicenseResponse>

Validates a license key and returns the license status.

validate.js

                1const { valid, plan, expiresAt } =
                await volt.validate(key)
              
2
3if (valid) {

                4 console.log(`Active license: ${plan}`)
              
5} else {

                6 console.log('Invalid or expired license')
              
7}

Response

response.json

1{

                2 "valid": true,
              
                3 "plan": "pro",
              
                4
                  "expiresAt": "2026-12-31",
              
                5
                  "customerId": "cus_..."
              
6}

Webhooks

VoltBee sends webhook events for purchases, renewals, and cancellations. Configure your webhook URL in the dashboard.

Events

license.created — New license purchased
license.renewed — Subscription renewed
license.canceled — Subscription canceled
license.expired — License expired

Webhook payload

webhook-payload.json

1{

                2
                  "event":
                  "license.created",
              
                3
                  "licenseKey":
                  "vb_lic_...",
              
                4 "plan": "pro",
              
                5
                  "customerId": "cus_...",
              
                6
                  "timestamp":
                  "2026-02-10T22:15:00Z"
              
7}

Rate Limits

The API has generous rate limits:

1000 requests per minute per API key
Responses are cached for 60 seconds per license key
Webhooks are retried up to 5 times with exponential backoff