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.
Request Path Parameters¶
|string||Unique identifier of the organization.|
Request Query Parameters¶
The following query parameters are optional:
|pageNum||integer||Optional||Page number, starting with one, that Atlas returns of the total number of objects.|
|itemsPerPage||integer||Optional||Number of items that Atlas returns per page, up to a maximum of 500.|
|includeCount||boolean||Optional||Flag that indicates whether Atlas returns the totalCount parameter in the response body.|
|pretty||boolean||Optional||Flag that indicates whether Atlas returns the JSON response in the prettyprint format.|
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
Endpoints that return a list of results use the results object as an envelope. Atlas adds the status parameter to the response body.
Request Body Parameters¶
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.
|object array||Includes one object for each item detailed in the results array section.|
|object array||Includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.|
|number||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.|
Each document in the
result array represents one invoice.
Charges are typically posted the next day.
|number||Amount billed in this invoice, calculated as |
|number||Amount paid for this invoice, in USD cents.|
|string||Timestamp in ISO 8601 date and time format in UTC when this invoice was created.|
|number||Amount credited by MongoDB, in USD cents.|
|string||Timestamp in ISO 8601 date and time format in UTC when the billing period for this invoice ended.|
|string||Unique identifier for this invoice.|
|object array||One or more links to sub-resources and/or related resources. The relation-types between URL|