Returns the status and details of a previously requested invoice report.
The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/operation-getorginvoicereport.
For more information and examples, see the referenced API documentation linked above.
Syntax
atlas api invoices getOrgInvoiceReport [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for getOrgInvoiceReport | |
--invoiceId | string | true | Unique string that identifies the invoice the report was generated for. |
--orgId | /orgs | true | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. |
-o, --output | string | false | preferred api format, can be ["json", go-template] This value defaults to "json". |
--outputFile | string | false | file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) |
--reportId | string | true | Unique string that identifies the report to retrieve. |
--version | string | false | API version to use when calling the Atlas API endpoints [options: "2025-03-12"]. If not set by the user, defaults to the latest version or the profile's api_version config value if set. This value defaults to "2025-03-12". |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Examples
atlas api invoices getOrgInvoiceReport --version 2025-03-12 --invoiceId [invoiceId] --orgId 4888442a3354817a7320eb61 --reportId [reportId]