Navigation

Get One Organization Invoice

On this page

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.

Base URL: 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:

Item Description
clusterName The name of the cluster that incurred the charge
created Timestamp in ISO 8601 date and time format in UTC when the line item was posted to the invoice.
endDate Timestamp in ISO 8601 date and time format in UTC when the period for which the line item applies ended.
discountCents Amount discounted, in USD cents. Displays when applicable.
groupId ID of the project with which the line item is associated.
note Note regarding the line item.
percentDiscount Percent of discount. Displays when applicable.
quantity Number of units of the line item (e.g. GB, hours, etc.).
sku Description of the line item. This could be the instance type, a support charge, advanced security, etc.
startDate Timestamp in ISO 8601 date and time format in UTC when the period for which the line item applies began.
stitchAppName Name of the MongoDB Realm app associated with the line item.
totalPriceCents

Total price for the line item, in USD cents. Equal to

 unitPriceDollars * quantity * 100
unit Unit of measure (e.g. GB, hours, etc.)
unitPriceDollars Cost of the item, in dollars.
links object array One or more links to sub-resources and/or related resources. The relation-types between URLs 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 payments array include the following fields:

Field Description
amountBilledCents The amount of the invoice, in USD cents.
amountPaidCents The amount that the customer paid, in USD cents.
created Timestamp in ISO 8601 date and time format in UTC when the payment was recorded.
id Unique identifier of the payment.
salesTaxCents Amount of sales tax paid, in USD cents.
statusName

State of the payment.

Status Description
CANCELLED The payment has been cancelled.
FAILED The attempt to charge the credit card failed.
FORGIVEN The payment was created, but was subsequently forgiven.
NEW The payment has been created, but no attempt has been made to charge the credit card.
PAID The payment was successful.
subtotalCents Sum of all positive invoice line items, in USD cents.
updated Timestamp in ISO 8601 date and time format in UTC when the object was last updated.
refunds object array

Refunds issued for the invoice. Objects in the refunds array include the following fields:

Field Description
amountCents The amount of the refund, in USD cents.
created Timestamp in ISO 8601 date and time format in UTC when the refund was recorded.
reason Reason for the refund.
paymentId Unique identifier of the payment.
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:

Status Description
CLOSED All charges for the subscription cycle have been finalized, the balance is more than zero, and the customer has not been charged yet.
FAILED An attempt to charge the credit card for the amount due failed.
FORGIVEN The customer has been charged, but the charge has been forgiven.
FREE The amount turned out to be zero, so the customer is not charged.
PAID The funds have been transferred to MongoDB, Inc.
PENDING Includes charges for the current subscription cycle. A customer should never have more than one invoice in this state.
PREPAID The customer has purchased credit from MongoDB sales, so the customer is not charged.
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.

If you specify "Accept: text/csv" in the request headers, the response is a CSV text file that includes the following fields:

Name Description
Date Timestamp in ISO 8601 date and time format in UTC when the period for which the line item applies ended.
Description Description of the line item.
Note Note regarding the line item.
Project Name of the project with which the line item is associated.
Project ID ID of the project with which the line item is associated.
SKU Description of the line item. This could be the instance type, a support charge, advanced security, etc.
Region Name of the region in which the charge was incurred.
Cluster The name of the cluster that incurred the charge.
Replica Set The name of the replica set that incurred the charge
Config Server The name of the config server that incurred the charge
Application Name of the MongoDB Realm app associated with the line item.
Unit Unit of measure of the item (e.g. hours, GB, etc.)
Unit Price Cost of the item, in dollars.
Quantity Number of units of the line item (e.g. GB, hours, etc.).
Discount Percent Percent of discount
Amount Total price for the line item, in USD. Equal to unitPriceDollars * quantity * 100.

Example Request

copy 
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}"
copy 
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: text/csv" \
     --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"

Note

The following sample response has been truncated for ease of viewing.

copy 
Invoice Number,{INVOICE-ID}
Company, "{COMPANY}"
Address,"{BILLING-ADDRESS}"
Billing Period,"September 1, 2018 - October 1, 2018"

Date,Description,Note,Project,Project ID,SKU,Region,Cluster,Replica Set,Config Server,Application,Unit,Unit Price,Quantity,Discount Percent,Amount
09/30/2018,Atlas AWS Data Transfer (Same Region) (N. Virginia) - docsfeedback,,{PROJECT-NAME},{PROJECT-ID},Atlas AWS Data Transfer (Same Region),N. Virginia,docsfeedback,,,,GB,0.010000,4.699437051200206,0.0,0.05
09/30/2018,Atlas AWS Data Transfer (Different Region) (N. Virginia) - docsfeedback,,{PROJECT-NAME},{PROJECT-ID},Atlas AWS Data Transfer (Different Region),N. Virginia,docsfeedback,,,,GB,0.020000,4.6175000000502064E-6,0.0,0.00
09/30/2018,Atlas AWS Data Transfer (Internet) (N. Virginia) - docsfeedback,,{PROJECT-NAME},{PROJECT-ID},Atlas AWS Data Transfer (Internet),N. Virginia,docsfeedback,,,,GB,0.090000,1.507005000002115E-4,0.0,0.00
09/30/2018,MongoDB Realm Data Downloaded (Free Tier) - feedback,,{PROJECT-NAME},{PROJECT-ID},MongoDB Realm Data Downloaded (Free Tier),,,,,feedback,GB,0.000000,1.8073254138E-5,0.0,0.00
...

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.