Managing Users, Projects and Consumption
Overview
Your Climatiq account is built around three main concepts:
- Projects: Workspaces that organize your API keys and track usage. You can create as many as you need (for example, one per client, use-case, or team). When you first sign up, a default project called First Project is created automatically.
- API keys: Credentials that authenticate requests to the Climatiq platform. Each project can have multiple keys. If you use the Excel Add-in or Google Sheets Extension, you may know this as your “Climatiq Key” - it’s the same thing.
- Members: Collaborators you invite to a project. Members can view and manage the project’s API keys and monitor its consumption.
Projects
What is a project?
A project is a dedicated workspace within your Climatiq account. Each project has its own API keys and its own member list, keeping data and settings isolated from your other projects. There is no limit on the number of projects you can create.
When you create a Climatiq account, a default project called First Project is created automatically.
Creating a new project
- Click the API Toolkit drop down in the top-left navigation bar of the Climatiq dashboard
- Select the API keys option
- Select the First Project drop down
- Select Manage projects
- Click Add new project and give it a name
Your new project will appear in the project list, ready for you to add API keys and members.
Managing your projects
From the Projects page, you can see all your projects in one place. For each project you can:
- API Keys - view and manage the API keys associated with this project
- Members - manage who has access to this project
- Edit - rename the project
- Delete - remove the project
Members
Adding members to a project
Members can access a project’s API keys and track its consumption. This ensures colleagues can step in if a team member is unavailable and makes handovers straightforward if someone leaves the organization.
To add a member:
- Go to the project you want to share
- Click Members
- Click Add new member
- Enter the person’s email address — they will receive an invitation
All members of a project have the same level of access. There are no separate roles or permission levels within a project.
Note: Climatiq does not currently support organization-level accounts — each user account is its own standalone entity. If you need a consumption report across your whole organization, contact us via support and we will share one with you.
Removing a member
To remove a member’s access, go to the project’s Members page and remove them from the list.
When removing a member, keep in mind that they may have copied API keys before their access was revoked. As a precaution, it is good practice to rotate any keys they had access to. You can do this from the API Keys tab of the relevant project.
Consumption
What counts as one API call?
Consumption is tracked per successful API call. One successful calculation using any Climatiq product counts as one API call.
Note for batch API endpoint users: Sending one batch request does not count as one API call. Each item within the batch that is successfully processed counts individually towards consumption.
Note for Excel Add-in, Google Sheets Extension, and PCF Studio users: Each line of calculation that successfully returns a carbon emission estimate counts as one API call.
Failed or unsuccessful requests do not count toward your consumption.
Monitoring your usage
To see your current consumption:
- Log in and click your profile icon in the top right
- Navigate to API usage
Usage is broken down by project and by endpoint, so you can see exactly where your calls are coming from.
When does my quota reset?
- Monthly quotas reset at the start of each monthly billing cycle
- Annual quotas reset on your subscription renewal date
Check your Service Order for your reset date, or contact support if you are unsure.
What happens if I exceed my quota?
If you go over your quota, usage continues - Climatiq does not cut off access to ensure continuity with our services and avoiding disruptions to your processes. Our Customer Success team is notified automatically.
- If your Service Order includes overage terms, you will be billed accordingly
- If your Service Order does not include overage terms, we will reach out to discuss next steps
Overage charges are billed on the 5th of the following month.
Example: If you exceed your quota in April, the overage charge will appear on 5 May.