OBTER /api/atlas/v1.0/orgs/{orgId}/invoices/{invoiceId}

Retorna uma fatura que o MongoDB emitiu para a organização especificada. Uma string única de 24 dígitos hexadecimais que identifica a fatura. Você pode optar por receber esta fatura em formato JSON ou CSV. Se você tiver uma configuração de organização cruzada, você pode consultar uma fatura vinculada se tiver a função Administrador de faturamento da organização ou Proprietário da organização. Para calcular o valor total devido da fatura, some o valor total devido de cada pagamento incluído na fatura. Para calcular o valor devido do pagamento, use a fórmula totalBilledCents * unitPrice + salesTax - StartingBalanceCents.

Requisitos de função
  • Visualizador de Faturamento da Organização

parâmetros de caminho

  • orgId string Obrigatório

    String exclusiva de 24dígitos hexadecimais que identifica a organização que contém seus projetos. Use o ponto de extremidade /orgs para 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})$.

  • invoiceId string Obrigatório

    String única de 24 dígitos hexadecimais que identifica a fatura enviada à organização especificada. Normalmente, as cobranças são publicadas no dia seguinte.

    O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

parâmetros de query

  • envelope booleano

    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.

  • pretty booleano

    Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

    O valor padrão é false.

    Prettyprint

Respostas

  • OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • valueBilledCents integer(int64)

      Soma dos serviços que a organização especificada consumiu no período abrangido por esta fatura. Este parâmetro expressa seu valor em centavos (100ths de um dólar dos EUA).

    • valuePaidCents integer(int64)

      Soma que a organização especificada pagou para esta fatura. Este parâmetro expressa seu valor em centavos (100ths de um dólar dos EUA).

    • Criado string(data-hora)

      Data e hora em que o MongoDB Cloud criou esta fatura. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

    • CreditsCents integer(int64)

      Soma que o MongoDB Creditou a organização especificada para esta fatura. Este parâmetro expressa seu valor em centavos (100ths de um dólar dos EUA).

    • endDate string(data-hora)

      Data e hora em que o MongoDB Cloud encerrou o período de faturamento coberto por esta fatura. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

    • id string

      String única de 24 dígitos hexadecimais que identifica a fatura enviada à organização especificada. Normalmente, as cobranças são publicadas no dia seguinte.

      O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

    • itens de linha array[objeto]

      Lista que contém serviços individuais incluídos nesta fatura.

      Ocultar atributos LineItems Mostrar atributos dos itens de linha objeto

      Um serviço incluído nesta fatura.

      • clusterName string

        Rótulo legível por humanos que identifica o cluster que gerou a cobrança.

        O formato deve corresponder ao seguinte padrão: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

      • Criado string(data-hora)

        Data e hora em que o MongoDB Cloud criou este item de linha. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

      • descontoCents integer(int64)

        Soma pela qual o MongoDB descontou este item de linha. O MongoDB Cloud expressa esse valor em centavos (100ths de um dólar EUA). O recurso retorna este parâmetro quando um desconto se aplica.

      • endDate string(data-hora)

        Data e hora em que o MongoDB Cloud terminou de cobrar por este item de linha. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

      • groupId string

        String única de 24dígitos hexadecimais que identifica o projeto associado a este item de linha.

        O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

      • groupName string

        Etiqueta legível por humanos que identifica o projeto.

      • Observação string

        Comentário que se aplica a este item de linha.

      • percentDiscount número (flutuante)

        Porcentagem pela qual o MongoDB descontou este item de linha. O recurso retorna este parâmetro quando um desconto se aplica.

      • quantidade número (duplo)

        Número de unidades incluídas para o item de linha. Podem ser expressões de armazenamento (GB), tempo (horas) ou outras unidades.

      • sku string

        Descrição legível por humanos do serviço que este item de linha forneceu. Essa SKU (Unidade de manutenção de estoque) pode ser o tipo de instância, uma cobrança de suporte, uma segurança avançada ou outro serviço.

        Para ver como listar todos os possíveis...
      • startDate string(data-hora)

        Data e hora em que o MongoDB Cloud começou a cobrar por esse item de linha. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

      • stitchAppName string

        Etiqueta legível para humanos que identifica o aplicação Atlas App Services associado a este item de linha.

        Criar um novo Atlas App Service
      • tags objeto

        Um mapa de pares de valores-chave correspondentes às tags associadas ao recurso de item de linha.

        Hide tags attribute Show tags attribute objeto
        • * array[string] Propriedades adicionais

          Um mapa de pares de valores-chave correspondentes às tags associadas ao recurso de item de linha.

      • tierLowerBound número (duplo)

        Limite inferior para a faixa de quantidade de uso no nível de SKU atual.

        OBSERVAÇÃO: lineItems[n].tierLowerBound aparece somente se seu lineItems[n].sku for de nível.

      • tierUpperBound número (duplo)

        Limite superior para a faixa de quantidade de uso no nível de SKU atual.

        OBSERVAÇÃO: lineItems[n].tierUpperBound aparece somente se seu lineItems[n].sku for de nível.

      • totalPriceCents integer(int64)

        Soma do custo definido para este item de linha. O MongoDB nuvem expressa esse valor em centavos (100ths de um dólar dos EUA) e calcula esse valor como unitPriceDollars * quantity * 100.

      • unidade string

        Elemento usado para expressar a quantidade que esse item de linha mede. Esse valor pode ser elementos de tempo, capacidade de armazenamento e afins.

      • unitPriceDollars número (duplo)

        Valor por unidade deste item de linha expresso em dólares americanos.

    • embeddedInvoices array[objeto]

      Lista que contém as faturas das organizações vinculadas à organização pagadora .

    • orgId string

      String exclusiva de 24dígitos hexadecimais que identifica a organização cobrada pelos serviços consumidos pelo MongoDB Cloud.

      O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

    • pagamentos array[objeto]

      Lista que contém recursos transferidos para o MongoDB para cobrir o serviço especificado observado nesta fatura.

      Ocultar atributos de pagamentos Mostrar atributos de pagamentos objeto

      Fundos transferidos para o MongoDB para cobrir o serviço especificado nesta fatura.

      • valueBilledCents integer(int64)

        Soma dos serviços que a organização especificada consumiu no período abrangido por esta fatura. Este parâmetro expressa seu valor em centavos (100ths de um dólar dos EUA).

      • valuePaidCents integer(int64)

        Soma que a organização especificada pagou para a fatura associada. Este parâmetro expressa seu valor em centavos (100ths de um dólar dos EUA).

      • Criado string(data-hora)

        Data e hora em que o cliente fez essa tentativa de pagamento. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

      • moeda string

        A moeda em que o pagamento foi pago. Este parâmetro expressa seu valor no código de moeda ISO 4217 de letras 3.

      • id string

        String única de 24dígitos hexadecimais que identifica esse pagamento na fatura associada.

        O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

      • SalesTaxCents integer(int64)

        Soma do imposto sobre vendas aplicado a esta fatura. Este parâmetro expressa seu valor em centavos (100ths de um dólar dos EUA).

      • statusName string

        Fase do processamento do pagamento da fatura associada quando você fez esta solicitação. Estas fases incluem:

        • CANCELLED: O cliente ou o MongoDB cancelaram o pagamento.
        • ERROR: o problema surgiu ao tentar concluir o pagamento.
        • FAILED: MongoDB tentou cobrar o cartão de crédito sem sucesso.
        • FAILED_AUTHENTICATION: Falha na autenticação forte do cliente. Confirme que sua forma de pagamento está autenticada.
        • FORGIVEN: O cliente iniciou o pagamento que o MongoDB perdoou mais tarde.
        • INVOICED: o MongoDB emitiu uma fatura que incluía este item de linha.
        • NEW: O cliente forneceu um método de pagamento, mas o MongoDB não tentou cobrar o cartão de crédito.
        • PAID: O cliente enviou um pagamento com sucesso.
        • PARTIAL_PAID: o cliente pagou por parte deste item de linha.

        Os valores são NEW, FORGIVEN, FAILED, PAID, PARTIAL_PAID, CANCELLED, INVOICED, FAILED_AUTHENTICATION, PROCESSING, PENDING_REVERSAL ou REFUNDED.

      • subtotalCents integer(int64)

        Soma de todos os itens de linha de fatura positiva contidos nesta fatura. Este parâmetro expressa seu valor em centavos (100ths de um dólar dos EUA).

      • unitPrice string

        O preço unitário aplicado a amountBilledCents para calcular o valor total do pagamento. Esse valor é representado como uma string decimal.

      • Atualizado string(data-hora)

        Data e hora em que o cliente fez uma atualização nessa tentativa de pagamento. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

    • restituições array[objeto]

      Lista que contém os pagamentos que o MongoDB devolveu à organização para esta fatura.

      Ocultar atributos de devolução Mostrar atributos de reembolsos objeto

      Um pagamento que o MongoDB retornou à organização para esta fatura.

      • quantidadeCents integer(int64)

        Soma dos recursos devolvidos para a organização especificada expressa em centavos (100th of US Dólar).

      • Criado string(data-hora)

        Data e hora em que o MongoDB Cloud criou este retorno. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

      • deploymentId string

        String única de 24dígitos hexadecimais que identifica o pagamento que a organização fez.

        O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

      • Razão string

        Motivação de que o MongoDB aceitou para devolver recursos à organização.

    • SalesTaxCents integer(int64)

      Soma do imposto sobre vendas aplicado a esta fatura. Este parâmetro expressa seu valor em centavos (100ths de um dólar dos EUA).

    • startDate string(data-hora)

      Data e hora em que o MongoDB Cloud iniciou o período de cobrança coberto por esta fatura. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

    • initialBalanceCents integer(int64)

      Soma que a organização especificada deve ao MongoDB quando o MongoDB emitiu esta fatura. Este parâmetro expressa seu valor em dólares dos EUA.

    • statusName string

      Fase do processamento de pagamento em que essa fatura existe quando você fez essa solicitação. As fases aceitas incluem:

      • CLOSED: o MongoDB finalizou todas as cobranças no ciclo de cobrança , mas ainda não cobrou o cliente.
      • FAILED: O MongoDB tentou cobrar o cartão de crédito fornecido, mas a cobrança desse valor falhou.
      • FORGIVEN: O cliente iniciou o pagamento que o MongoDB perdoou mais tarde.
      • FREE: todas as cobranças totalizaram zero, portanto o cliente não será cobrado.
      • INVOICED: o MongoDB lidou com essas cobranças usando faturamento elástico.
      • PAID: MongoDB conseguiu cobrar o cartão de crédito fornecido.
      • PENDING: a fatura inclui cobranças para o ciclo de faturamento atual.
      • PREPAID: o cliente tem um plano pré-pago, portanto não será cobrado.

      Os valores são PENDING, CLOSED, FORGIVEN, FAILED, PAID, FREE, PREPAID ou INVOICED.

    • subtotalCents integer(int64)

      Soma de todos os itens de linha de fatura positiva contidos nesta fatura. Este parâmetro expressa seu valor em centavos (100ths de um dólar dos EUA).

    • Atualizado string(data-hora)

      Data e hora em que o MongoDB Cloud atualizou pela última vez o valor deste pagamento. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

  • 401 aplicação/json

    Não autorizado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 403 aplicação/json

    Forbidden.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 404 aplicação/json

    Não encontrado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 500 aplicação/json

    Erro interno do servidor.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

GET /api/atlas/v1.0/orgs/{orgId}/invoices/{invoiceId}
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/orgs/4888442a3354817a7320eb61/invoices/{invoiceId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Exemplos de resposta (200)
{
  "amountBilledCents": 42,
  "amountPaidCents": 42,
  "created": "2026-05-04T09:42:00Z",
  "creditsCents": 42,
  "endDate": "2026-05-04T09:42:00Z",
  "id": "32b6e34b3d91647abb20e7b8",
  "lineItems": [
    {
      "clusterName": "string",
      "created": "2026-05-04T09:42:00Z",
      "discountCents": 42,
      "endDate": "2026-05-04T09:42:00Z",
      "groupId": "32b6e34b3d91647abb20e7b8",
      "groupName": "string",
      "note": "string",
      "percentDiscount": 42.0,
      "quantity": 42.0,
      "sku": "string",
      "startDate": "2026-05-04T09:42:00Z",
      "stitchAppName": "string",
      "tags": {
        "additionalProperty1": [
          "string"
        ],
        "additionalProperty2": [
          "string"
        ]
      },
      "tierLowerBound": 42.0,
      "tierUpperBound": 42.0,
      "totalPriceCents": 42,
      "unit": "string",
      "unitPriceDollars": 42.0
    }
  ],
  "linkedInvoices": [
    {}
  ],
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "payments": [
    {
      "amountBilledCents": 42,
      "amountPaidCents": 42,
      "created": "2026-05-04T09:42:00Z",
      "currency": "string",
      "id": "32b6e34b3d91647abb20e7b8",
      "salesTaxCents": 42,
      "statusName": "NEW",
      "subtotalCents": 42,
      "unitPrice": "string",
      "updated": "2026-05-04T09:42:00Z"
    }
  ],
  "refunds": [
    {
      "amountCents": 42,
      "created": "2026-05-04T09:42:00Z",
      "paymentId": "32b6e34b3d91647abb20e7b8",
      "reason": "string"
    }
  ],
  "salesTaxCents": 42,
  "startDate": "2026-05-04T09:42:00Z",
  "startingBalanceCents": 42,
  "statusName": "PENDING",
  "subtotalCents": 42,
  "updated": "2026-05-04T09:42:00Z"
}
Exemplos de resposta (200)
Invoice Number,666acb8787ba43606905dcae,
Billing Period,"June 1, 2024 - July 1, 2024",
Organization Name,Test 2,
Organization ID,666acb8787ba43606905dcac,

Date,Usage Date,Description,Note,Organization Name,Organization ID,Project,Project ID,SKU,Region,Cluster,Replica Set,Config Server,Application,Unit,Unit Price,Quantity,Discount Percent,Amount
Exemplos de resposta (401)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 401,
  "errorCode": "NOT_ORG_GROUP_CREATOR",
  "reason": "Unauthorized"
}
Exemplos de resposta (403)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 403,
  "errorCode": "CANNOT_CHANGE_GROUP_NAME",
  "reason": "Forbidden"
}
Exemplos de resposta (404)
{
  "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"
}
Exemplos de resposta (500)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 500,
  "errorCode": "UNEXPECTED_ERROR",
  "reason": "Internal Server Error"
}