Navigation

Get All Invoices for One Organization

Retrieves all invoices for one organization.

Base URL: https://cloud.mongodb.com/api/public/v1.0

Resource

GET /orgs/{ORG-ID}/invoices/

Request Path Parameters

Name Type Description
ORG-ID string Unique identifier of the organization.

Request Query Parameters

This endpoint may use any of the HTTP request query parameters available to all Cloud Manager API resources. These are all optional.

Name Type Description Default
pageNum integer Page number (1-based). 1
itemsPerPage integer Maximum number of items to return, up to a maximum of 100. 100
pretty boolean Indicates whether the response body should be in a prettyprint format. false
envelope boolean

Indicates whether or not to wrap the response in an envelope.

Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return a list of results, the results object is an envelope. Cloud Manager adds the status field to the response body.

false

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response

Response Document

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

Name Type Description
results object array This array includes one object for each item detailed in the results Embedded Document section.
links object array This array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
totalCount number The count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

results Embedded Document

Each result is one invoice.

Name Type Description
id string Unique identifier for this invoice.
amountBilledCents number Amount billed in this invoice, calculated as subtotalCents + salesTaxCents - startingBalanceCents
amountPaidCents number Amount paid for this invoice.
created string Timestamp in ISO 8601 date and time format in UTC when this invoice was created.
endDate string Timestamp in ISO 8601 date and time format in UTC when the billing period for this invoice ended.
groupId string Unique identifier of the project that was included in this invoice.
links object array One or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification
lockedAt string Timestamp in ISO 8601 date and time format in UTC when this invoice was locked.
note string Annotation on this invoice that explains or clarifies information within the invoice.
orgId string Unique identifier for the organization that received this invoice.
paymentMethod string Means by which this invoice has been paid.
salesTaxCents number Amount of taxes levied on subtotalCents.
startDate string Timestamp in ISO 8601 date and time format in UTC of the starting date for this invoice.
startingBalanceCents number Carried over balance from prior billing period in cents.
status string

State of this invoice. Accepted values are:

Status Description
PENDING Includes charges for the current subscription cycle. A customer should never have more than one invoice in this state.
CLOSED All charges for the subscription cycle have been finalized, the balance is more than zero, and the customer has not been charged yet.
FORGIVEN The customer has been charged, but the charge has been forgiven.
CHARGE_FAILED An attempt to charge the credit card for the amount due failed.
PAID The funds have been transferred to MongoDB, Inc.
FREE The amount turned out to be zero, so the customer is not charged.
PREPAID The customer is on a prepaid plan, so the customer is not charged.
subtotalCents number Sum of all positive invoice line items in cents.
updated string Timestamp in ISO 8601 date and time format in UTC of the latest oplog entry in the restored snapshot.

Example Request

curl --user "{USERNAME}:{APIKEY}" --digest \
 --header "Content-Type: application/json" \
 --include \
 --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invoices/?pretty=true"

Example Response

Response Header

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}

Response Body

{
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invoices/?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "amountBilledCents" : 0,
    "amountPaidCents" : 0,
    "created" : "2017-04-27T06:00:03Z",
    "endDate" : "2017-05-27T00:00:00Z",
    "groupId" : "{PROJECT-ID}",
    "id" : "{INVOICE-ID-1}",
    "links" : [ {
      "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invoices/{INVOICE-ID-1}/csv",
      "rel" : "self"
    } ],
    "orgId" : "{ORG-ID}",
    "paymentMethod" : "CREDIT_CARD",
    "salesTaxCents" : 0,
    "startDate" : "2017-04-27T00:00:00Z",
    "startingBalanceCents" : 0,
    "status" : "FREE",
    "subtotalCents" : 0,
    "updated" : "2017-05-27T06:00:04Z"
  }, {
    "amountBilledCents" : 0,
    "amountPaidCents" : 0,
    "created" : "2017-05-27T06:00:04Z",
    "endDate" : "2017-05-01T00:00:00Z",
    "groupId" : "{PROJECT-ID}",
    "id" : "{INVOICE-ID-2}",
    "links" : [ {
      "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invoices/{INVOICE-ID-2}/csv",
      "rel" : "self"
    } ],
    "orgId" : "{ORG-ID}",
    "salesTaxCents" : 0,
    "startDate" : "2017-05-27T00:00:00Z",
    "startingBalanceCents" : 0,
    "status" : "PENDING",
    "subtotalCents" : 0,
    "updated" : "2017-05-27T06:00:04Z"
  }, {
    "example" : "continues"
  } ],
  "totalCount" : 17
}