Menu

Rate this page:

Users API

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.

Retrieve your credit balance

GET /v3/user/credits

Base url: https://api.sendgrid.com

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.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.

Responses

object
remain
integer

The remaining number of credits available on your account.

required
total
integer

The total number of credits assigned to your account.

required
overage
integer

The number of overdrawn credits for your account.

required
used
integer

The number of credits that you have used.

required
last_reset
string

The date that your credit balance was last reset.

required
next_reset
string

The next date that your credit balance will be reset.

required
reset_frequency
string

The frequency at which your credit balance will be reset.

required
        
        
        
        Rate this page:

        Need some help?

        We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.

              
              
              

              Thank you for your feedback!

              We are always striving to improve our documentation quality, and your feedback is valuable to us. Please select the reason(s) for your feedback or provide additional information about how we can improve:

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              Refer us and get $10 in 3 simple steps!

              Step 1

              Get link

              Get a free personal referral link here

              Step 2

              Give $10

              Your user signs up and upgrade using link

              Step 3

              Get $10

              1,250 free SMSes
              OR 1,000 free voice mins
              OR 12,000 chats
              OR more