Get One Organization Invoice
On this page
- OAuth 2.0 authentication for programmatic access to Cloud Manager is available as a Preview feature.
- The feature and the corresponding documentation might change at any time during the Preview period. To use OAuth 2.0 authentication, create a service account to use in your requests to the Cloud Manager Public API.
Base URL: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /orgs/{ORG-ID}/invoices/{INVOICE-ID}
Request Path Parameters
Name | Type | Description |
|---|---|---|
| string | Unique identifier of the organization. |
| string | Unique identifier of the invoice. Charges are typically posted the next day. |
Request Query Parameters
The following query parameters are optional:
Name | Type | Necessity | Description | Default |
|---|---|---|---|---|
pageNum | number | Optional | One-based integer that returns a subsection of results. |
|
itemsPerPage | number | Optional | Number of items to return per page, up to a maximum of 500. |
|
pretty | boolean | Optional | Flag that indicates whether the response body should be in a prettyprint format. |
|
envelope | boolean | Optional | Flag that indicates whether or not to wrap the response in an envelope. Some API clients cannot access the HTTP response headers or
status code. To remediate this, set For endpoints that return a list of results, the |
|
backupJobsEnabledOnly | boolean | Optional | Flag indicating whether to exclude daemons not enabled for
backing up databases from the response. Set this to |
|
Request Body Parameters
This endpoint doesn't 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 | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| number | Amount billed in this invoice, calculated as subtotalCents + salesTaxCents - startingBalanceCents | ||||||||||||||||||||||||||||||
| number | Amount paid for this invoice. | ||||||||||||||||||||||||||||||
| 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 of the project with which the invoice is associated. Does not appear on all invoices. | ||||||||||||||||||||||||||||||
| string | Unique identifier for this invoice. | ||||||||||||||||||||||||||||||
| object array | Line items in the invoice. This information is also found in the Usage Details section of the Invoice page in the Cloud Manager UI. Each object in the array includes the following fields:
| ||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||
| string | Unique identifier for the organization that received this invoice. | ||||||||||||||||||||||||||||||
| object array | Payments applied to the invoice. Objects in the
| ||||||||||||||||||||||||||||||
| object array | Refunds issued for the invoice. Objects in the
| ||||||||||||||||||||||||||||||
| number | Amount of taxes levied on subtotalCents. | ||||||||||||||||||||||||||||||
| string | Timestamp in ISO 8601 date and time format in UTC of the starting date for this invoice. | ||||||||||||||||||||||||||||||
| string | State of this invoice. Accepted values are:
| ||||||||||||||||||||||||||||||
| number | Sum of all positive invoice line items in USD cents. | ||||||||||||||||||||||||||||||
| 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/public/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, "replicaSetName": "rs0", "sku" : "CLOUD_MANAGER_BASIC", "startDate" : "2018-04-30T00:00:00Z", "totalPriceCents" : 0, "unitPriceDollars" : 0.0 }, { "clusterName" : "{CLUSTER-NAME}", "created" : "2018-04-30T04:05:19Z", "endDate" : "2018-04-30T00:00:00Z", "groupId" : "{PROJECT-ID}", "quantity" : 72.0, "replicaSetName": "rs0", "sku" : "CLOUD_MANAGER_BASIC", "startDate" : "2018-04-29T00:00:00Z", "totalPriceCents" : 0, "unitPriceDollars" : 0.0 }, ... , { "clusterName" : "{CLUSTER-NAME}", "created" : "2018-04-02T06:05:07Z", "endDate" : "2018-04-02T00:00:00Z", "groupId" : "{PROJECT-ID}", "quantity" : 72.0, "replicaSetName": "rs0", "sku" : "CLOUD_MANAGER_BASIC", "startDate" : "2018-04-01T00:00:00Z", "totalPriceCents" : 0, "unitPriceDollars" : 0.0 } ], "links" : [ { "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}", "rel" : "http://mms.mongodb.com/org" }, { "href" : "https://cloud.mongodb.com/api/public/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"