Skip to content

API keys

Where an Admin creates and revokes the keys that authenticate calls to the Clix REST API.

Business plan only

REST API access is on the Business plan. On Free and Pro this screen shows a View plans link instead of the key list — there is no key to create. See Plans, limits and fair use.

Who. Admin only. No other role can see or create keys.

Tasks

Create a key

Why. Your own system needs to issue or read invoices without a person signing in.

Who. Admin, on the Business plan.

  1. Open API Keys and click Create key.
  2. Enter a Key name that says where it will be used — warehouse-sync, not key 1.
  3. Choose the Access level. The default, Create and view invoices, is right for a system that issues invoices; pick a view-only level for reporting tools.
  4. Click Create key.
  5. Copy the key from the Copy your key now confirmation, then click I have stored it. The key is shown once.

Result. The key is active immediately and can call the API on behalf of your organisation.

Store it safely

The key is shown once. Copy it into your secret store when it is created; you cannot read it again afterwards. If it is lost, revoke it and create another.

A key carries your organisation's access. Anyone holding it can issue invoices in your name, so treat it as a credential:

  • never commit it to a repository or paste it into a ticket
  • give each system its own key, so one can be revoked without stopping the others
  • revoke immediately if you suspect it has leaked

Revoke a key

Who. Admin.

  1. On API Keys, click Revoke on the key's row.
  2. In Revoke this key?, click Revoke key. The dialog names the key by its public prefix, the clix_ part before the secret.

Result. The key disappears from the list and the very next call with it answers 401 Invalid or revoked API key (verified 2026-09-27; the dialog's "within a minute" is the outer bound). This cannot be undone. Invoices already issued with the key are unaffected — they are real invoices and stay cleared.

Limits

API calls are rate limited per key and are not metered against a monthly quota; invoices created through the API count against the plan's invoice allowance like any other. See Usage and quotas and Errors and rate limits.