- 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 s are explained in the Web Linking Specification. | |||||||||||||||||||||||||||||||
orgId | string | Unique identifier for the organization that received this invoice. | |||||||||||||||||||||||||||||||
payments | object array | Payments applied to the invoice. Objects in the
| |||||||||||||||||||||||||||||||
refunds | object array | Refunds issued for the invoice. Objects in the
| |||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||
statusName | string | State of this invoice. Accepted values are:
| |||||||||||||||||||||||||||||||
subtotalCents | number | Sum of all positive invoice line items in USD cents. | |||||||||||||||||||||||||||||||
updated | string | Timestamp in ISO 8601 date and time format in UTC when the invoice was last updated. |
If you set the query element envelope to true, the
response is wrapped by the content object.
Example Request¶
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/invoices/{INVOICE-ID}"
Example Response¶
Note
In the following sample response, the lineItems array
has been truncated for ease of viewing.
{ "amountBilledCents" : 240, "amountPaidCents" : 240, "created" : "2018-04-01T06:14:31Z", "endDate" : "2018-05-01T00:00:00Z", "id" : "{INVOICE-ID}", "lineItems" : [ { "clusterName" : "{CLUSTER-NAME}", "created" : "2018-05-01T04:05:31Z", "endDate" : "2018-05-01T00:00:00Z", "groupId" : "{PROJECT-ID}", "quantity" : 72.0, "sku" : "ATLAS_INSTANCE_M0", "startDate" : "2018-04-30T00:00:00Z", "totalPriceCents" : 0, "unit": "server hours", "unitPriceDollars" : 0.0 }, { "clusterName" : "{CLUSTER-NAME}", "created" : "2018-04-30T04:05:19Z", "endDate" : "2018-04-30T00:00:00Z", "groupId" : "{PROJECT-ID}", "quantity" : 72.0, "sku" : "ATLAS_INSTANCE_M0", "startDate" : "2018-04-29T00:00:00Z", "totalPriceCents" : 0, "unit": "server hours", "unitPriceDollars" : 0.0 }, ... , { "clusterName" : "{CLUSTER-NAME}", "created" : "2018-04-02T06:05:07Z", "endDate" : "2018-04-02T00:00:00Z", "groupId" : "{PROJECT-ID}", "quantity" : 72.0, "sku" : "ATLAS_INSTANCE_M0", "startDate" : "2018-04-01T00:00:00Z", "totalPriceCents" : 0, "unit": "server hours", "unitPriceDollars" : 0.0 } ], "links" : [ { "href" : "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}", "rel" : "http://mms.mongodb.com/org" }, { "href" : "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/invoices/{INVOICE-ID}", "rel" : "self" } ], "orgId" : "{ORG-ID}", "payments" : [ { "amountBilledCents" : 240, "amountPaidCents" : 240, "created" : "2018-05-01T04:05:14Z", "id" : "{PAYMENT-ID}", "salesTaxCents" : 19, "statusName" : "PAID", "subtotalCents" : 221, "updated" : "2018-05-01T07:00:46Z" } ], "refunds" : [ ], "salesTaxCents" : 19, "startDate" : "2018-04-01T00:00:00Z", "startingBalanceCents" : 0, "statusName" : "PAID", "subtotalCents" : 221, "updated" : "2018-05-01T07:00:46Z"
Give Feedback