Retorna todas as faturas que a MongoDB emitiu para a organização especificada . Esta lista inclui todas as faturas, independentemente do status da fatura. Se você tiver uma configuração de organização cruzada, você pode visualizar as faturas vinculadas se tiver a função de Administrador de Cobrança da Organização ou Proprietário da Organização. Para calcular o valor total devido das faturas - some o total devido de cada fatura. Pode ser calculado como uma soma do valor devido de cada pagamento incluído na fatura. Para calcular o valor devido do pagamento, use a fórmula totalBilledCents * unitPrice + salesTax - startingBalanceCents.
- Visualizador de Faturamento da Organização
parâmetros de caminho
-
String exclusiva de 24dígitos hexadecimais que identifica a organização que contém seus projetos. Use o ponto de extremidade
/orgspara recuperar todas as organizações às quais o usuário autenticado tem acesso.O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{24})$.
parâmetros de query
-
Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON
envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.O valor padrão é
false. -
Sinalizador que indica se a resposta retorna o número total de itens (
totalCount) na resposta.O valor padrão é
true. -
Número de itens que a resposta retorna por página.
O valor mínimo é
1, o valor máximo é500. O valor padrão é100. -
Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
O valor mínimo é
1. O valor padrão é1. -
Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
O valor padrão é
false.Prettyprint -
Sinalizador que indica se as faturas vinculadas devem ser retornadas no campo
linkedInvoices.O valor padrão é
true. -
Status da fatura a ser recuperada. Omitir para retornar faturas de todos os status.
Os valores são
PENDING,CLOSED,FORGIVEN,FAILED,PAID,FREE,PREPAIDouINVOICED. -
Recupere as faturas cujo
startDatesseja maior ou igual afromDate. Se omitir, a devolução das faturas voltará para astartDatemais antiga. -
Recupere as faturas cujo
endDatesseja menor ou igual atoDate. Se omitido, a devolução das faturas irá para oendDatemais recente. -
Campo usado para classificar as faturas devolvidas. Use em combinação com o parâmetro
orderBypara controlar a ordem do resultado.Os valores são
START_DATEouEND_DATE. O valor padrão éEND_DATE. -
Campo usado para solicitar as faturas devolvidas. Use em combinação do parâmetro
sortBypara controlar a ordem do resultado.Os valores são
descouasc. O valor padrão édesc.
curl \
--request GET 'https://cloud.mongodb.com/api/atlas/v1.0/orgs/4888442a3354817a7320eb61/invoices' \
--header "Authorization: Bearer $ACCESS_TOKEN"{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [
{
"amountBilledCents": 42,
"amountPaidCents": 42,
"created": "2026-05-04T09:42:00Z",
"creditsCents": 42,
"endDate": "2026-05-04T09:42:00Z",
"id": "32b6e34b3d91647abb20e7b8",
"linkedInvoices": [
{}
],
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"salesTaxCents": 42,
"startDate": "2026-05-04T09:42:00Z",
"startingBalanceCents": 42,
"statusName": "PENDING",
"subtotalCents": 42,
"updated": "2026-05-04T09:42:00Z"
}
],
"totalCount": 42
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 401,
"errorCode": "NOT_ORG_GROUP_CREATOR",
"reason": "Unauthorized"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 403,
"errorCode": "CANNOT_CHANGE_GROUP_NAME",
"reason": "Forbidden"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"error": 404,
"errorCode": "RESOURCE_NOT_FOUND",
"reason": "Not Found"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 500,
"errorCode": "UNEXPECTED_ERROR",
"reason": "Internal Server Error"
}