Skip to main content
You can control which users may subscribe to your plans — allow selected users onto a private plan, or block a user from subscribing.

Creating a user-specific API plan

You can offer private plans to selected customers. Create a plan, open it for editing and set its visibility to Private. Then, in the Custom Users section, add the username of each user you want to allow. Users you allow can see and subscribe to the private plan on the API’s pricing page, even though it stays hidden from everyone else. There it carries a Private badge, so they know it was offered to them, and it gets a card of its own, apart from your public plans. This works on a private API too: the users you add can open its page, which stays hidden from everyone else. Each user you add gets an email with a link to the plan, so you don’t need to send it yourself (see Email notifications). Image Pn

Blocking a user

To prevent a user from subscribing to a plan, add them in the Custom Users section and click Block. Image 1 Pn
Blocking only prevents new subscriptions. A user who is already subscribed keeps their access — to end it, cancel their subscription from Studio → Subscriptions.

Email notifications

Each change you make in Custom Users is emailed to the user, with what it means for them: A user who is subscribed to the plan is told that their current subscription continues. No email is sent when the change makes no difference to the user: blocking someone on a private plan they had no access to, or removing an allowed user from a public plan. Setting the state a user already has changes nothing at all. When an email cannot be delivered, for example to an address that no longer accepts mail, the Studio tells you right after the change, so you can let the user know yourself. Adding a user who is already allowed sends their email again when the last one did not go out, which also reaches users you added before these emails existed.

Limits

You can make up to 100 changes to custom users in 24 hours, and up to 10 to the same user. Past a limit the change is refused, not made without an email, and the message says when you can try again. Setting the state a user already has is not a change and does not count.

From the Management API and the CLI

Changing custom users with POST v2/set-user-custom-api-plan (Management API) or jojapi plans access (CLI) emails users the same way. The answer has a notification object:
Past a limit the answer is "status": "rate_limited" and nothing changes.