Menu

Expand

This documentation is for the SendGrid Web API v2

To access all the latest features and upcoming developments, please see our v3 API.

Account Overview

View general account information regarding your customers, including billing cycle, current billing cycle, credit usage, package, overage credits, etc.

URI Parameter Required Requirements Description
task Yes Must be set to overview . The task that allows us to present the customer's information.
user Yes Customer that is registered under your account. The customer

These are Reseller only APIs. For more information, see the Reseller Overview.

Call

POST https://api.sendgrid.com/apiv2/reseller.account.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=overview&user=eexampexample@example.com

Response

{
  "reputation": "100",
  "requests": "500000",
  "package": "Silver Package",
  "credits_allowed": "50000",
  "credits_used": "100000",
  "credits_remain": 0,
  "credits_overage": "50000",
  "billing_start_date": "2010-08-30",
  "billing_end_date": "2010-09-29",
  "billing_process_date": "2010-09-30"
}

Call

POST https://api.sendgrid.com/apiv2/reseller.account.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=overview&user=eexampexample@example.com

Response

<result>
   <overview>
      <reputation>100</reputation>
      <requests>50000</requests>
      <package>Silver Package</package>
      <credits_allowed>50000</credits_allowed>
      <credits_used>100000</credits_used>
      <credits_remain>0</credits_remain>
      <credits_overage>50000</credits_overage>
      <billing_start_date>2010-08-30</billing_start_date>
      <billing_end_date>2010-09-29</billing_end_date>
      <billing_process_date>2010-09-30</billing_process_date>
   </overview>
</result>

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.