aimldocs
Console

Organization settings

Create an organization, keep its profile and billing details current, manage members and roles, transfer ownership, and close it.

An organization owns everything else in the console: projects, API keys, credits, invoices and members. You can belong to several organizations and switch between them at any time.

Organization settings are under Settings in the sidebar. The page has seven tabs: Profile, Billing details, Members, SSO, Data policy, Security and Danger zone. This page covers the profile, billing, members and danger zone tabs. The others have their own pages: single sign-on, data policy and security.

Create an organization

The first time you sign in you land on Get started, which walks through six steps: Verify email, Create organisation, First project, First key, Quick start and Credits. Your email address was verified when you signed in, so you begin at the second step.

  1. Enter a Name. The Slug is filled in from the name, and you can change it before you create the organization. It takes lowercase letters, digits and dashes, and it becomes part of your console URL.
  2. Choose the Billing country. It sets your currency and payment rail, shown under the field. India is billed in INR, and the other countries listed are billed in USD.
  3. Choose the Kind: Personal, Team or Enterprise.
  4. If the billing country is India, you can enter a GSTIN (optional). A valid GSTIN is printed on your invoices. Leave it empty to continue as unregistered.
  5. If an Invite code field is shown, enter the code you were sent.
  6. If a verification check is shown, complete it.
  7. Press Create organisation.

The billing country and currency lock after the first invoice, so choose them with care.

The next steps show the default project your organization starts with, create your first key (the secret is shown once), and offer a test request with Send test request. The last step takes you to Top up now, or you can press Skip for now. See API keys and credits.

Invites and the waitlist

When sign-ups are by invitation, your first organization needs an invite code. If you have none, use No invite? Join the waitlist below the form: say what you will build, add your company if you like, and press Join the waitlist. While your entry is pending you can change it with Update my entry. Once it is approved, the page says so and you can create your organization with no code. If the request is declined, an invite code still works.

Once you belong to an organization, you can create more without a code.

If you sign up on a reseller's own domain, the reseller decides who can join. Its page may ask for an invite code that the reseller sent you, or say that it is not taking new sign-ups. See getting access.

Switch between organizations

The Organisation selector at the left of the top bar lists every organization you belong to. Choose one to switch. The project selector and the live and test switch beside it then apply to that organization.

To add another organization, choose + Create organisation in the same selector.

Profile

The Profile tab shows the organization's Name and Slug, with its plan, kind and status below.

  • You can change the name and press Save. This needs the owner or admin role.
  • The slug is permanent.

Billing details

The Billing details tab holds what is printed on your invoices. Changing it needs the owner or admin role.

  • Legal name: printed on invoices.
  • GSTIN (India only): leave it empty if you are unregistered. A valid GSTIN shows its state and place of supply under the field, and sets the tax status to gst_registered.
  • Tax status: unregistered, gst_registered, export or sez. It is fixed while a valid GSTIN is entered.
  • PAN (India only): printed on invoices for unregistered recipients.
  • Billing email: invoices and pre-debit notices go here.
  • Billing address: two address lines, city, state, postal code and country. For India the state is the GST state code.

Press Save billing details. The button stays disabled while the GSTIN or PAN is malformed. Saved details apply to the next invoice. Invoices already issued never change. To correct one, see invoices.

The billing country and currency are shown at the top of the tab and cannot be edited here.

Members

The Members tab lists everyone in the organization with their role. Changing anything here needs the owner or admin role.

Roles

RoleWhat it can do
ownerEverything, including transferring ownership, requesting erasure and closing the organization.
adminEverything an owner can, except those three owner-only actions.
billingRead the organization and its usage, and manage credits.
memberCreate and manage projects, API keys, apps and evals. Read usage, credits, routing policies, webhooks and provider keys.
viewerRead only.

Invite someone

  1. Enter the person's address under Invite by email.
  2. Choose a Role. Only an owner can invite another owner.
  3. Press Invite.

An invite works for a person who has signed in to the console at least once. Ask a new colleague to sign in first, then invite them.

Change a role

Use the role selector on the member's row. The change is saved as soon as you choose. Only an owner can make someone an owner, and the last owner cannot be demoted.

Remove a member

Press Remove on the member's row, type the member's email address to confirm, and press Remove member. The last owner cannot be removed.

If your organization uses a directory, members can also be added and removed for you. See single sign-on and SCIM.

Transfer ownership

Only the owner can do this, on the Danger zone tab.

  1. Under Transfer ownership, choose the New owner. The person must already be a member.
  2. Press Transfer.
  3. Type transfer to confirm, and press Transfer ownership.

The person you chose becomes the owner and you become an admin.

Erase the organization's data

Only the owner can request this, under Data erasure on the Danger zone tab.

Press Request erasure. A 30-day wait starts, and the tab shows the date and the days left. During the wait you can press Cancel erasure. When the wait ends, archived payloads and request logs become unreadable and personal data is removed. You receive a completion receipt through the erasure.completed webhook; see webhooks.

The ledger and invoices are kept, as tax law requires.

To erase the data of one of your own end users instead, see privacy requests.

Close the organization

Only the owner can do this, under Close organisation on the Danger zone tab. Closing revokes every API key immediately.

Closing is blocked while credits remain, unless you ask for the unused balance to be refunded.

  1. If you have credits left, tick Refund remaining credits to the original payment method. A refund ticket is filed for the finance team.
  2. Press Close organisation….
  3. Type the organization's slug to confirm, and press Close organisation.

Once closed, the tab shows when the organization was closed.

On this page