On this page

Retrieve your credit balance

API Overview

Keeping your user profile up to date helps SendGrid verify who you are and share important communications with you.

You can learn more in the SendGrid Account Details documentation.

Operation overview

GET/v3/user/credits

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

This endpoint allows you to retrieve the current credit balance for your account.

Each account has a credit balance, which is a base number of emails it can send before receiving per-email charges. For more information about credits and billing, see Billing and Plan details information.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstringOptional

The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Responses

200

SchemaExample

Property nameTypeRequiredDescriptionChild properties

remaininteger

The remaining number of credits available on your account.

totalinteger

The total number of credits assigned to your account.

overageinteger

The number of overdrawn credits for your account.

usedinteger

The number of credits that you have used.

last_resetstring

The date that your credit balance was last reset.

next_resetstring

The next date that your credit balance will be reset.

reset_frequencystring

The frequency at which your credit balance will be reset.

Retrieve your credit balance

1const client = require('@sendgrid/client');
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
5const request = {
6  url: `/v3/user/credits`,
7  method: 'GET',
8  
9}
10
11client.request(request)
12  .then(([response, body]) => {
13    console.log(response.statusCode);
14    console.log(response.body);
15  })
16  .catch(error => {
17    console.error(error);
18  });