Navigation

Get All Invoices for One Organization

The Atlas API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.

To learn how to configure API access for an Atlas project, see Configure Atlas API Access.

https://cloud.mongodb.com/api/atlas/v1.0

GET /orgs/{ORG-ID}/invoices/
NameTypeDescription
ORG-IDstringUnique identifier of the organization.

The following query parameters are optional:

NameTypeNecessityDescriptionDefault
pageNumintegerOptionalPage number, starting with one, that Atlas returns of the total number of objects.1
itemsPerPageintegerOptionalNumber of items that Atlas returns per page, up to a maximum of 500.100
includeCountbooleanOptionalFlag that indicates whether Atlas returns the totalCount parameter in the response body.true
prettybooleanOptionalFlag that indicates whether Atlas returns the JSON response in the prettyprint format.false
envelopebooleanOptional

Flag that indicates whether Atlas wraps 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.

Endpoints that return a list of results use the results object as an envelope. Atlas adds the status parameter to the response body.

false

This endpoint does not use HTTP request body parameters.

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.

NameTypeDescription
resultsobject arrayIncludes one object for each item detailed in the results array section.
linksobject arrayIncludes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
totalCountnumberCount 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.

Each document in the result array represents one invoice. Charges are typically posted the next day.

NameTypeDescription
amountBilledCentsnumberAmount billed in this invoice, calculated as subtotalCents + salesTaxCents - startingBalanceCents.
amountPaidCentsnumberAmount paid for this invoice, in USD cents.
createdstringTimestamp in ISO 8601 date and time format in UTC when this invoice was created.
creditsCentsnumberAmount credited by MongoDB, in USD cents.
endDatestringTimestamp in ISO 8601 date and time format in UTC when the billing period for this invoice ended.
idstringUnique identifier for this invoice.
linksobject arrayOne or more links to sub-resources and/or related resources. The relation-types between URL s are explained in the Web Linking Specification.
groupIdstringUnique identifier of the project with which the invoice is associated. Does not appear on all invoices.
orgIdstringUnique identifier for the organization that received this invoice.
salesTaxCentsnumberAmount of taxes levied on subtotalCents.
startDatestringTimestamp in ISO 8601 date and time format in UTC of the starting date for this invoice.
statusNamestring

State of this invoice. Accepted values are:

StatusDescription
PAIDThe funds have been transferred to MongoDB.
PREPAIDThe customer has purchased credit from MongoDB sales, so the customer is not charged.
FREEThe amount turned out to be zero, so the customer is not charged.
PENDINGIncludes charges for the current subscription cycle. An organization should never have more than one invoice in this state.
FORGIVENThe charge has been forgiven. If the charge succeeded, it has been refunded.
FAILEDAn attempt to charge the credit card for the amount due failed.
CLOSEDAll charges for the subscription cycle have been finalized, the balance is more than zero, and the customer has not been charged yet.
subtotalCentsnumberSum of all positive invoice line items in USD cents.
updatedstringTimestamp in ISO 8601 date and time format in UTC when the invoice was last updated.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Content-Type: application/json" \
--include \
--request GET "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/invoices/?pretty=true"
{
"links" : [ {
"href" : "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/invoices/?pretty=true&pageNum=1&itemsPerPage=100",
"rel" : "self"
} ],
"results" : [ {
"amountBilledCents" : 0,
"amountPaidCents" : 0,
"created" : "2018-06-01T04:05:10Z",
"endDate" : "2018-07-01T00:00:00Z",
"id" : "{INVOICE-ID}",
"links" : [ {
"href" : "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/invoices/{INVOICE-ID}",
"rel" : "self"
} ],
"orgId" : "{ORG-ID}",
"salesTaxCents" : 0,
"startDate" : "2018-06-01T00:00:00Z",
"startingBalanceCents" : 0,
"statusName" : "PENDING",
"subtotalCents" : 0,
"updated" : "2018-06-01T04:05:10Z"
}, {
"amountBilledCents" : 726,
"amountPaidCents" : 726,
"created" : "2018-02-01T06:05:04Z",
"endDate" : "2018-03-01T00:00:00Z",
"id" : "{INVOICE-ID}",
"links" : [ {
"href" : "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/invoices/{INVOICE-ID}",
"rel" : "self"
} ],
"orgId" : "{ORG-ID}",
"salesTaxCents" : 57,
"startDate" : "2018-02-01T00:00:00Z",
"startingBalanceCents" : 0,
"statusName" : "PAID",
"subtotalCents" : 669,
"updated" : "2018-03-01T07:00:54Z"
} ],
"totalCount" : 16
}
Give Feedback