Customers and limits

The Customers tab lists every team that signed up on your portal. Search by name or email, filter by status, and open a customer to see their usage, balance, keys and teammates.

The list

Each row shows the customer's status, plan, balance, requests this month and last request. The test customer is marked Test, and a custom tag means the customer has their own limits.

Export CSV downloads every customer with their ID, email, status, plan, balance, requests this month and dates, for spreadsheets or your CRM.

Inviting customers

Click Invite and enter an email address. The person gets an email with a link to create their account on your portal. The link works for 14 days. Invites are the only way in when your portal's sign up mode is Invite only. See sign up modes.

Approving sign ups

With the Approval sign up mode, new customers wait as Pending and their keys don't work yet. Workspace owners and admins get an email for each one. Click Approve in the list or on the customer's page, and the customer gets an email that their account is ready.

Suspending a customer

Suspend on the customer's page stops their keys within a minute: your API answers 403. Their balance, keys and history are kept, and Reactivate brings them back.

Delete customer is permanent. Their keys stop working, any subscription is canceled, and their balance and usage history are deleted. The activity log keeps a record of the deletion.

Custom limits

The Custom limits card sets a price per billable request, requests a second or requests a month for this one customer. Custom limits win over the customer's plan and your defaults, field by field. Leave a field blank to inherit it, and use 0 for no rate limit or no quota. See effective limits.

Use them for a partner with a higher rate limit, a pilot with free requests or an account with a negotiated price.

Plans

The Plan card shows the customer's plan and whether it is billed through Stripe. You can put a customer on any plan yourself, including a private one. A plan you assign isn't billed through Stripe, which suits customers you invoice yourself. Choose the No plan option to move them back to your defaults.

Credit

Add credit and Remove change the balance by hand. Each change needs a note, which the customer sees in their history, and takes an optional reference such as an invoice number. MicroAuth ignores a second change with the same reference, so a retried script can't add credit twice. To do the same from your own systems, use the credits endpoint.

Balance history lists every change: welcome credit, top ups, plan credit, your adjustments, refunds and one line per day of usage charges.

Keys and teammates

API keys lists the customer's keys with when each was last used. Revoke stops a key within a minute, and the customer can create a new one on the portal. Portal users lists the people on the customer's team and their roles.

Notes

Notes are private to your workspace. Use them for context like a contract date or a contact person.

The test customer

Every API has one test customer, with a key on the Connect tab. It pays with test credit, never real money, and doesn't count toward your plan's customer limit. Add $5 tops up its test balance, and New key replaces its key if it leaked. Its requests show up as test requests and stay out of your revenue numbers.