View general account information regarding your customers, including billing cycle, current billing cycle, credit usage, package, overage credits, etc.
Parameter
Required
Requirements
Description
task
Yes
Must be set to
overview .
The task that allows us to present the customers
information.
user
Yes
Customer that is registered under your account.
The customer
XML Call
1
https://sendgrid.com/api/distributor.account.xml?api_user=username&api_key=secureSecret&task=overview&user=customer@example.com
Response: Success
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<?xml version="1.0" encoding="ISO-8859-1"?>
<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>
Response: Error
1
2
3
4
5
6
7
8
9
10
11
<?xml version="1.0" encoding="ISO-8859-1"?>
<result>
<message> error</message>
<errors>
<error>
... error messages ...
</error>
...
</errors>
</result>
JSON Call
1
https://sendgrid.com/api/distributor.account.json?api_user=username&api_key=secureSecret&task=overview&user=customer@example.com
Response: Success
1
2
"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"
Response: Error
1
2
3
4
5
6
{
"message" : "error" ,
"errors" : [
"...error messages..."
]
}