Atlas Admin API invoice endpoints
Parent: Atlas Billing and Invoice Anatomy · Published reference · snapshot 2026-10-24 · skill mongodb-cohort-4308c7661d27
↓ Facts as markdownall context files
Source-anchored research for Atlas Admin API invoice endpoints. Run status: COMPLETED.
These notes link each claim to its source. Some citations identify archived research reports that are no longer hosted on this site. A published reference means the content is available; it does not certify independent review or accuracy.Read the editorial policy and follow the sources before relying on a claim.
How it works
- GET /api/atlas/v2/orgs/{orgId}/invoices/pending returns invoices accruing charges in the current billing cycle. Organization Billing Viewer provides read access; linked invoices require Organization Billing Admin or Organization Owner. (high confidence) (verified as of 2026-10-24) [source]
- GET /api/atlas/v2/orgs/{orgId}/invoices/pending returns invoices accruing charges in the current billing cycle; it is not a finalized month-end total. The generated CLI counterpart is atlas api invoices listInvoicePending. (high confidence) (verified as of 2026-10-24) [source]
Problems, failure modes and limitations
- MongoDB’s published default rate-limit table assigns invoice report generation a separate ORGANIZATION bucket (capacity 20; refill 10 per 60 seconds). It lists the organization invoice and Cost Explorer usage endpoints under an ORGANIZATION bucket (capacity 500; refill 100 per 60 seconds); SKU list and get endpoints use a separate USER bucket (capacity 300; refill 100 per 60 seconds). These are defaults, are not part of the API contract, and may change without notice; organizations with support-approved higher limits may differ. (low confidence) (verified as of 2026-10-24) [source]
- For generated FOCUS reports, MongoDB instructs clients to poll no more often than every five seconds and increase the interval exponentially for slow reports. A successful response includes an expiring download URL valid for 15 minutes. (low confidence) (verified as of 2026-10-19) [source]
Comparisons and alternatives
- The invoice family includes issued-invoice listing, individual JSON/CSV retrieval, current-cycle pending invoices, line-item search, asynchronous reports, and SKU lookup. These are separate operations rather than one report endpoint. (high confidence) [source]
- Pending costs change until billing closes. Re-fetch closed months; update stored pending lines instead of blindly appending each refresh. (high confidence) (verified as of 2026-10-19) [source]
Facts and statements
- Atlas exposes organization invoice operations through the Atlas Admin API; the generated atlas api invoices command family maps to those API operations. Billing ingestion can run in external tools, as Ternary and Cloudaware document. (high confidence) [source]
- GET /api/atlas/v2/orgs/{orgId}/associatedInvoices retrieves invoice identifiers for a month and year. Both parameters default to the current period, and includeLinkedOrgs defaults to false, so cross-organization report collection must explicitly request linked invoices. (high confidence) (verified as of 2026-10-19) [source]
- GET /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search returns invoice line items as JSON. It requires a JSON request body; an empty object retrieves unfiltered items. The CLI accepts a request file or standard input and exposes pageNum and itemsPerPage. (high confidence) (verified as of 2026-10-24) [source]
- FOCUS report generation is asynchronous: POST /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/reports with reportType FOCUS and reportFormat CSV returns a reportId. GET on the same path followed by /{reportId} retrieves report state and, upon success, its download URL. (high confidence) (verified as of 2026-10-19) [source]
- FOCUS retrieval should poll no more than once every five seconds, with exponential backoff. Download URLs last 15 minutes; retrieving the same report refreshes an expired URL. Reports remain available for seven days. (low confidence) (verified as of 2026-10-19) [source]
- FOCUS excludes commitment shortfalls, tax, adjustments, and refunds. OpenProfit excludes invoice-level credits and tax from its line-item ingestion. Usage extracts need not equal the full payable invoice. (high confidence) (verified as of 2026-10-19) [source]
- Organization Billing Viewer is sufficient for read-only billing collection in the documented OpenProfit and Cloudaware integrations. Ternary additionally requests Organization Read Only for its API-key setup; its Organization Owner requirement concerns creating credentials. (high confidence) (verified as of 2026-10-24) [source]
- Credential support depends on the integration: Ternary accepts service-account client credentials or API keys, whereas Cloudaware documents API-key support and calls that authentication legacy. Do not infer every consumer supports the same authentication path. (high confidence) (verified as of 2026-10-22) [source]
- The MongoDB atlas-billing repository demonstrates importing organization invoices into Atlas for visualization, but its README explicitly deprecates the solution and says it is no longer maintained. Treat its Realm/App Services deployment instructions as historical examples. (low confidence) (verified as of 2026-10-24) [source]
- A May 2022 community report describes 401 errors while configuring Digest authentication for invoice collection. The reply asks whether the key is authorized for the invoice context; the thread provides no confirmed resolution. (low confidence) [source]
- listSkus enumerates billable product/service SKUs with pagination; getSku retrieves a SKU by identifier. SKU metadata is distinct from the organization-specific invoice and line-item operations. (high confidence) [source]
- The pending-invoice operation requires Organization Billing Viewer access. Viewing linked invoices in a cross-organization setup requires Organization Billing Admin or Organization Owner; a billing-viewer credential alone should not be assumed to expose every linked invoice. (high confidence) (verified as of 2026-10-24) [source]
- GET /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search queries one invoice and returns JSON. The generated CLI command requires orgId and invoiceId and accepts the request payload through a file or standard input. (high confidence) (verified as of 2026-10-24) [source]
- The lineItems:search operation documents a required JSON request body even though its HTTP method is GET; an empty JSON object requests unfiltered results. It supports project and cluster filters, billing and usage dates, zero-cent inclusion, service filters, and sorting. Pagination defaults to 100 items and permits at most 500 per page. (low confidence) (verified as of 2026-10-24) [source]
- For App Services attribution, the pending-invoice line-item schema includes stitchAppName, described as the associated Atlas App Services application label. Separately, lineItems:search accepts App Services in filters.skuServices. These fields support historical cost attribution; they do not establish current application availability. (high confidence) (verified as of 2026-10-24) [source]
- Ternary and Cloudaware independently document integrations that ingest organization billing through Atlas invoice or Administration APIs. Both prescribe Organization Billing Viewer for their integration credentials, corroborating practical read-only FinOps use of the endpoints. (high confidence) (verified as of 2026-10-24) [source]
- Ternary documents API-key credentials with Organization Billing Viewer plus Organization Read Only, and alternatively service-account Client ID and Client Secret. Organization Owner is needed to create its integration credentials; this is distinct from the runtime credential permissions. (low confidence) (verified as of 2026-04-13) [source]
- Cloudaware's documentation says MongoDB recommends service accounts and considers API keys a legacy authentication method. Cloudaware currently supports API-key authentication for its Atlas billing integration. Its troubleshooting steps check organization billing access, credentials, organization ID, and invoice availability for the selected period. (low confidence) (verified as of 2026-10-22) [source]
Children
- No children recorded.