API

myaccount.billing.get

From GoGrid



Contents

This call will retrieve a single billing summary object.


Request

URL


Role Based Access Control Permissions

  • Super User
  • Billing User

Input Request Query Parameters

Required Name Version Type Description
Required api_key 1.0 string An API Key generated by GoGrid.
  sig 1.0 string An MD5 Signature that signs each and every API request. Instructions on how to generate this signature can be found here.
v 1.0 string The version of the API. For more information, see API Versions.
  • For version 1.3, set parameter to 1.3
 
Optional
format 1.0 string The output format of the response. For more information, see Output Formats.
  • For JSON, set parameter to json.
  • For XML, set parameter to xml.
  • For CSV, set parameter to csv.
  • Default is json.

Sample Request

To get your billing summary: 

https://api.gogrid.com/api/myaccount/billing/get?
  ... auth parameters...


Response


A common get response for Billing Summary.

JSON Response

{
   "list":[
      {
         "memoryAllotment":0,
         "memoryAccrued":192,
         "transferAllotment":0,
         "object":"billingsummary",
         "startDate":null,
         "memoryInUse":0.5,
         "transferOverage":0,
         "transferAccrued":0,
         "memoryOverage":52,
         "endDate":null,
         "memoryOverageCharge":9.879999876022339,
         "transferOverageCharge":0
      }
   ],
   "summary":{
      "total":1,
      "start":0,
      "returned":1
   },
   "status":"success",
   "method":"/myaccount/billing/get"
}

XML Response

<gogrid>
  <response method="/myaccount/billing/get" status="success">
    <summary total="1" start="0" returned="1"/>
    <list>
      <object name="billingsummary">
        <attribute name="startDate">Sat Jul 12 00:00:00 PDT 2008</attribute>
        <attribute name="endDate">Tue Aug 12 00:00:00 PDT 2008</attribute>
        <attribute name="memoryAllotment">0</attribute>
        <attribute name="memoryInUse">0.5</attribute>
        <attribute name="memoryAccrued">192</attribute>
        <attribute name="memoryOverage">52</attribute>
        <attribute name="memoryOverageCharge">9.879999876022339</attribute>
        <attribute name="transferAllotment">0</attribute>
        <attribute name="transferAccrued">0</attribute>
        <attribute name="transferOverage">0</attribute>
        <attribute name="transferOverageCharge">0.0</attribute>
      </object>
    </list>
  </response>
</gogrid>

XML Response

# SUCCESS, /myaccount/billing/get, TOTAL, 1, START, 0, RETURNED, 1
# startDate,endDate,memoryAllotment,memoryInUse,memoryAccrued,memoryOverage,memoryOverageCharge,transferAllotment,transferAccrued,transferOverage,transferOverageCharge
Sat Jul 12 00:00:00 PDT 2008,Tue Aug 12 00:00:00 PDT 2008,0,0.5,192,52,9.879999876022339,0,0,0,0.0

Error Codes

Status Code Description
400 IllegalArgumentException Any problems with input parameters will generate an IllegalArgumentException.
401 Unauthorized This error code will occur when the role tied to the API Key in your request has the wrong Access Controls.
403 Authentication Failed This error code will occur when your request is not properly signed. Make sure your have a valid API key and secret and that you are properly generating a request signature. Ensure that the clock on the computer from which you are making the request is synchronized woth the GoGrid API Server.
404 Not Found This error will occur if you have specified a method that does not exist or any other URL does not exists on the API Server.
500 UnexpectedError These types of errors indicate an internal system problem. Depending on the severity of the error and whether not it is blocking your development, report the error to GoGrid support by emailing the response to apisupport@gogrid.com.
Retrieved from "http://wiki.gogrid.com/wiki/index.php/API:myaccount.billing.get"
Personal tools