Get All Pending Invoices for One Organization¶

On this page

Resource

Request Path Parameters
Request Query Parameters
Request Body Parameters
Response
Example Request
Example Response

The Atlas Administration 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 Get Started with the Atlas Administration API.

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

Resource¶

GET /orgs/{ORG-ID}/invoices/pending

Request Path Parameters¶

Name	Type	Description
`ORG-ID`	string	Unique identifier of the organization.

Request Query Parameters¶

This endpoint might use any of the HTTP request query parameters available to all Atlas Administration API resources. All of these are optional.

Name

Type

Necessity

Description

Default

pretty

boolean

Optional

Flag indicating whether the response body should be in a prettyprint format.

false

envelope

boolean

Optional

Flag indicating if Atlas should wrap the response in a JSON envelope.

This option may be needed for some API clients. These clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return one result, the response body includes:


status	HTTP response code
envelope	Expected response body

false

Request Body Parameters¶

This endpoint does not use HTTP request body parameters.

Response¶

If you set the query element envelope to true, the response is wrapped by the content object.

The HTTP response returns a JSON document that includes the following objects:

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 uniform resource locators that link to sub-resources and/or related resources. The Web Linking Specification explains the relation-types between URLs.

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

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.

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/pending

Example Response¶

Note

In the following sample response, the lineItems array has been truncated for ease of viewing.

{
  "amountBilledCents" : 0,
  "amountPaidCents" : 0,
  "created" : "2018-06-01T04:05:10Z",
  "endDate" : "2018-07-01T00:00:00Z",
  "id" : "{INVOICE-ID}",
  "lineItems" : [ {
    "clusterName" : "{CLUSTER-NAME}",
    "created" : "2018-06-19T04:06:14Z",
    "endDate" : "2018-06-19T00:00:00Z",
    "groupId" : "5b27f9e387d9d66681302c72",
    "quantity" : 12.0,
    "sku" : "ATLAS_AWS_INSTANCE_M10",
    "startDate" : "2018-06-18T00:00:00Z",
    "totalPriceCents" : 31,
    "unit": "server hours",
    "unitPriceDollars" : 0.026
  }, {
    "clusterName" : "{CLUSTER-NAME}",
    "created" : "2018-06-19T04:06:14Z",
    "endDate" : "2018-06-19T00:00:00Z",
    "groupId" : "5b27f9e387d9d66681302c72",
    "quantity" : 1.0,
    "sku" : "ATLAS_ADVANCED_SECURITY",
    "startDate" : "2018-06-18T00:00:00Z",
    "totalPriceCents" : 4,
    "unit": "hours",
    "unitPriceDollars" : 0.0351
  },
  ... ,
  {
    "clusterName" : "{CLUSTER-NAME}",
    "created" : "2018-06-02T04:05:07Z",
    "endDate" : "2018-06-02T00:00:00Z",
    "groupId" : "5898b95f87d9d6270e8995d9",
    "quantity" : 72.0,
    "sku" : "ATLAS_INSTANCE_M0",
    "startDate" : "2018-06-01T00:00:00Z",
    "totalPriceCents" : 0,
    "unit": "server hours",
    "unitPriceDollars" : 0.0
  } ],
  "links" : [ {
    "href" : "https://cloud-dev.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}",
    "rel" : "http://mms.mongodb.com/org"
  }, {
    "href" : "https://cloud-dev.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/invoices/{INVOICE-ID}",
    "rel" : "self"
  } ],
  "orgId" : "{ORG-ID}",
  "payments" : [ ],
  "refunds" : [ ],
  "salesTaxCents" : 0,
  "startDate" : "2018-06-01T00:00:00Z",
  "startingBalanceCents" : 0,
  "statusName" : "PENDING",
  "subtotalCents" : 0,
  "updated" : "2018-06-01T04:05:10Z"
}

← Get One Organization Invoice Projects →