Skip to content

Knowledgebase & Docs

Search guides, configuration tutorials, API references, and troubleshooting solutions.

Authenticate with the KBilling API

Category: API & Integrations 2 Views 0 Helpful Votes

Create scoped credentials, restrict source IPs and make a secure authenticated request.

Create credentials

  1. Open System Settings → API Console.
  2. Add the integration server’s exact public source IP.
  3. Create credentials for an active administrator identity.
  4. Select the minimum required action scopes and copy the secret once.

Send a request

curl -X POST 'https://billing.example.com/api/YOUR_PRIVATE_ENDPOINT_KEY' \
  -H 'Authorization: Basic BASE64_IDENTIFIER_COLON_SECRET' \
  -H 'Content-Type: application/json' \
  -d '{"action":"GetClients","limitnum":25}'

Requests are POST-only. Send credentials in the Authorization header, never the query string. Store the secret in a protected server-side secret manager.

Mutating requests

Add a unique idempotency key to create, update, payment or lifecycle requests:

X-Idempotency-Key: order-sync-20261101-000042

Reuse the same key only when retrying the identical operation. Reusing it with a different payload is rejected.