Skip to main content

At a glance

  • Availability: Experimental (how to enable).
  • Authentication: Basic auth.
  • Connection: HTTP Basic auth with BILLBEE_USERNAME as the username and BILLBEE_API_PASSWORD as the password.
  • Provider documentation: Authentication reference.

Credentials

Set these per environment. See Connect an integration.

Setup

  1. Create a Billbee account: Sign up at https://app.billbee.io - a free trial is available for testing.
  2. Activate the API and set an API password: In Billbee open Settings → API (https://app.billbee.io/app_v2/settings/api/general), activate the API module, and set a dedicated API password. This is separate from your account login password.
  3. Request an API key: Email [email protected] with a short note about what you are building to receive a developer API key. This key identifies your application and is sent as the X-Billbee-Api-Key header.
  4. Store the credentials: Add BILLBEE_USERNAME (your Billbee login email), BILLBEE_API_PASSWORD, and BILLBEE_API_KEY to your .env file, then run the List Orders tool to verify access.

Provider notes

  • Every request needs BOTH HTTP Basic auth (username + API password) AND the X-Billbee-Api-Key header
  • Rate limit: max 2 requests per second per API key + user combination; some endpoints have stricter per-call throttles
  • Responses wrap payloads in a Data field alongside Paging and ErrorMessage fields
Provider API reference.

Tools

Verify the connection

Call a read tool such as billbee__list_orders with arguments for your account. Confirm that the result comes from the intended account or workspace before enabling write tools.