- API >
- API Resources >
- Invoices
Get One Organization Invoice¶
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
Resource¶
GET /orgs/{ORG-ID}/invoices/{INVOICE-ID}
Request Path Parameters¶
Name | Type | Description |
---|---|---|
ORG-ID | string | Unique identifier of the organization. |
INVOICE-ID | string | Unique identifier of the invoice. Charges are typically posted the next day. |
Request Query Parameters¶
The following query parameters are optional:
Query Parameter | Type | Description | Default |
---|---|---|---|
pretty | boolean | Displays response in a prettyprint format. | false |
envelope | boolean | Specifies whether or not to wrap the response in an envelope. | false |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Request Headers¶
This endpoint can return its content in JSON or CSV format. Use the
Accept
request header to specify your desired the content type.
- For JSON, use
"Accept: application/json"
; - For CSV, use
"Accept: text/csv"
Response¶
If you specify Accept: application/json
in the request
headers, the HTTP response is a JSON document that includes
the following fields:
Name | Type | Description | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. | |||||||||||||||||||||||||||||||
creditsCents | number | Amount credited by MongoDB, in USD cents. | |||||||||||||||||||||||||||||||
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 with which the invoice is associated. Does not appear on all invoices. | |||||||||||||||||||||||||||||||
id | string | Unique identifier for this invoice. | |||||||||||||||||||||||||||||||
lineItems | object array | Line items in the invoice. This information is also found in the Usage Details section of the Invoice page in the Atlas UI. Each object in the array includes the following fields:
| |||||||||||||||||||||||||||||||
links | object array | One or more links to sub-resources and/or related resources. The relation-types between URL |