Devuelve una factura para una organización

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

Devuelve una factura que MongoDB ha emitido a la organización especificada. Una unique 24-hexadecimal digit string identifica la factura. Puedes elegir recibir esta factura en formato JSON o CSV. Si tienes una configuración entre organizaciones, puedes consultar una factura vinculada si tienes el rol de Organization Billing Admin o Organization Owner. Para calcular el importe total adeudado de la factura, sume el importe total adeudado de cada pago incluido en la factura. Para calcular la cantidad adeudada del pago, utiliza la fórmula totalBilledCents * unitPrice + salesTax - startingBalanceCents.

Requisitos del rol
  • Visualizador de facturación de la organización

Parámetros de path

  • orgId string Requerido

    string única de 24dígitos hexadecimales que identifica la organización que contiene su proyectos. Utilice el /orgs endpoint para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso.

    El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

  • invoiceId string Requerido

    String única de 24 dígitos hexadecimales que identifica la factura enviada a la organización especificada. Los cargos suelen publicarse al día siguiente.

    El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

Parámetros de query

  • envelope booleano

    Bandera que indica si la aplicación envuelve la respuesta en un objeto JSON envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.

    El valor por defecto es false.

  • bonito booleano

    Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.

    El valor por defecto es false.

    pretty-print

Respuestas

  • OK

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • amountBilledCents integer(int64)

      Suma de los servicios que la organización especificada consumió en el periodo cubierto en esta factura. Este parámetro expresa su valor en centavos (100avos de un dólar estadounidense).

    • amountPaidCents integer(int64)

      Suma que la organización especificada pagó hacia esta factura. Este parámetro expresa su valor en centavos (100avos de un dólar estadounidense).

    • creado string(date-time)

      Fecha y hora en que MongoDB Cloud creó esta factura. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

    • créditosCéntimos integer(int64)

      Suma que MongoDB acreditó a la organización especificada para esta factura. Este parámetro expresa su valor en centavos (100avos de un dólar estadounidense).

    • endDate string(date-time)

      Fecha y hora en que MongoDB Cloud finalizó el período de facturación que cubre esta factura. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

    • ID string

      String única de 24 dígitos hexadecimales que identifica la factura enviada a la organización especificada. Los cargos suelen publicarse al día siguiente.

      El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

    • elementos de línea arreglo[objeto]

      Lista que contiene los servicios individuales incluidos en esta factura.

      Ocultar los atributos de lineItems Mostrar atributos lineItems Objeto

      Un servicio incluido en esta factura.

      • Nombre del clúster string

        Etiqueta legible por humanos que identifica al clúster al que se le aplicó el cargo.

        El formato debe coincidir con el siguiente patrón: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

      • creado string(date-time)

        Fecha y hora en que MongoDB Cloud creó este elemento. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

      • Centavos de descuento integer(int64)

        Suma con la que MongoDB aplicó un descuento en este concepto. MongoDB Cloud expresa este valor en centavos (100avos de un dólar estadounidense). El recurso devuelve este parámetro cuando se aplica un descuento.

      • endDate string(date-time)

        Fecha y hora en que MongoDB nube terminó de cobrar esta partida. Este parámetro expresa su valor en el formato de timestamp ISO 8601 en UTC.

      • ID del grupo string

        string única de 24dígitos hexadecimales que identifica el Proyecto asociado a este elemento de línea.

        El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

      • groupName string

        Etiqueta legible por humanos que identifica el proyecto.

      • Nota string

        Comentario que aplica a este concepto.

      • descuentoPorcentaje número(flotante)

        Porcentaje con el que MongoDB ha descontado este artículo de línea. El recurso devuelve este parámetro cuando se aplica un descuento.

      • cantidad número(double)

        Número de unidades incluidas para la partida. Estas pueden ser expresiones de almacenamiento (GB), tiempo (horas) u otras unidades.

      • sku string

        Descripción legible del servicio que proveyó este elemento. Esta Unidad de mantenimiento de stock (SKU) puede ser el tipo de instancia, un cargo por soporte, seguridad avanzada u otro servicio.

        Para ver cómo enumerar todos los posibles...
      • startDate string(date-time)

        Fecha y hora en que MongoDB Cloud comenzó a cobrar por este concepto. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

      • stitchAppName string

        etiqueta legible por humanos que identifica la aplicación Atlas App Services asociada con este elemento de línea.

        Crear un nuevo Servicio de Apps de Atlas
      • etiqueta Objeto

        Un mapa de pares clave-valor que corresponde a las etiquetas asociadas con el recurso del concepto de partida.

        Hide tags attribute Show tags attribute Objeto
        • * array[string] Propiedades adicionales

          Un mapa de pares clave-valor que corresponde a las etiquetas asociadas con el recurso del concepto de partida.

      • tierLowerBound número(double)

        Límite inferior para el rango de cantidad de uso en el nivel de SKU actual.

        NOTA: lineItems[n].tierLowerBound aparece solo si tu lineItems[n].sku es de nivel.

      • tierUpperBound número(double)

        Límite superior para el rango de cantidad de uso en el nivel actual de SKU.

        NOTA: lineItems[n].tierUpperBound aparece solo si tu lineItems[n].sku es de nivel.

      • totalPriceCents integer(int64)

        Suma del costo fijado para esta línea de artículos. MongoDB Nube expresa este valor en centavos americanos (100de un dólar estadounidense) y calcula este valor como unitPriceDollars * quantity * 100.

      • unidad string

        Elemento utilizado para Express qué cantidad mide este artículo. Este valor puede referirse a elementos de tiempo, capacidad de almacenamiento y similares.

      • unitPriceDollars número(double)

        Valor por unidad para esta partida expresado en dólares estadounidenses.

    • Facturas vinculadas arreglo[objeto]

      Lista que contiene las facturas de organizaciones vinculadas a la organización pagadora.

    • orgId string

      string única de dígitos hexadecimales 24que identifica a la organización a la que se le cobran los servicios consumidos de MongoDB nube.

      El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

    • Pagos arreglo[objeto]

      Lista que contiene los fondos transferidos a MongoDB para cubrir el servicio especificado mencionado en esta factura.

      Ocultar atributos de pagos Mostrar atributos de pagos Objeto

      Fondos transferidos a MongoDB para cubrir el servicio especificado en esta factura.

      • amountBilledCents integer(int64)

        Suma de los servicios que la organización especificada consumió en el periodo cubierto en esta factura. Este parámetro expresa su valor en centavos (100avos de un dólar estadounidense).

      • amountPaidCents integer(int64)

        Suma que la organización especificada pagó en relación con la factura asociada. Este parámetro expresa su valor en centavos (100a parte de un dólar estadounidense).

      • creado string(date-time)

        Fecha y hora en que el cliente realizó este intento de pago. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

      • moneda string

        La moneda en la que se realizó el pago. Este parámetro expresa su valor en 3el código 4217 de divisa ISO de letras.

      • ID string

        string única de 24dígitos hexadecimales que identifica este pago para la factura asociada.

        El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

      • salesTaxCents integer(int64)

        Suma del impuesto sobre las ventas aplicado en esta factura. Este parámetro expresa su valor en centavos (100a parte de un dólar estadounidense).

      • Nombre del estado string

        Etapa del procesamiento de pagos para la factura asociada cuando realizó esta solicitud. Estas fases incluyen:

        • CANCELLED: El cliente o MongoDB canceló el pago.
        • ERROR: Se presentó un problema al intentar completar el pago.
        • FAILED: MongoDB intentó cobrar la tarjeta de crédito sin éxito.
        • FAILED_AUTHENTICATION: Ha fallado la Autenticación por parte del cliente. Confirme que su método de pago esté autenticado.
        • FORGIVENPago iniciado por el cliente que MongoDB perdonó posteriormente.
        • INVOICEDMongoDB emitió una factura que incluía este renglón.
        • NEW: El cliente proporcionó un método de pago, pero MongoDB no ha intentado cobrar la tarjeta de crédito.
        • PAID: El cliente presentó un pago exitoso.
        • PARTIAL_PAID: El cliente pagó por parte de esta línea de artículos.

        Los valores son NEW, FORGIVEN, FAILED, PAID, PARTIAL_PAID, CANCELLED, INVOICED, FAILED_AUTHENTICATION, PROCESSING, PENDING_REVERSAL o REFUNDED.

      • subtotalCents integer(int64)

        Suma de todos los conceptos de factura positivos incluidos en esta factura. Este parámetro expresa su valor en centavos (100a parte de un dólar estadounidense).

      • unitPrice string

        El precio unitario aplicado a amountBilledCents para calcular el importe total del pago. Este valor está representado como una string decimal.

      • actualizado string(date-time)

        Fecha y hora en que el cliente realizó una actualización a este intento de pago. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

    • reembolsos arreglo[objeto]

      Lista que contiene pagos que MongoDB devolvió a la organización para esta factura.

      Ocultar atributos de reembolsos Mostrar atributos de reembolsos Objeto

      Un pago que MongoDB devolvió a la organización por esta factura.

      • amountCents integer(int64)

        Suma de los fondos devueltos a la organización especificada expresada en centavos (100avo de Dólar estadounidense).

      • creado string(date-time)

        Fecha y hora en que MongoDB nube creó este reembolso. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

      • idPago string

        string única de 24dígitos hexadecimales que identifica el pago realizado por la organización.

        El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

      • motivo string

        Justificación de que MongoDB aceptó devolver los fondos a la organización.

    • salesTaxCents integer(int64)

      Suma del impuesto sobre las ventas aplicado en esta factura. Este parámetro expresa su valor en centavos (100a parte de un dólar estadounidense).

    • startDate string(date-time)

      Fecha y hora en que MongoDB Cloud comenzó el período de facturación que cubre esta factura. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

    • startingBalanceCents integer(int64)

      Suma que la organización especificada debía a MongoDB cuando MongoDB emitió esta factura. Este parámetro expresa su valor en dólares estadounidenses.

    • Nombre del estado string

      Fase del procesamiento de pagos en la que se encuentra esta factura cuando realizaste esta solicitud. Las fases aceptadas incluyen:

      • CLOSED: MongoDB finalizó todos los cargos en el ciclo de facturación, pero aún no ha cobrado al cliente.
      • FAILEDMongoDB intentó cargar la tarjeta de crédito proporcionada, pero el cargo por esa cantidad falló.
      • FORGIVENPago iniciado por el cliente que MongoDB perdonó posteriormente.
      • FREETodos los cargos totalizaron cero, por lo que al cliente no se le cobrará.
      • INVOICEDMongoDB gestionó estos cargos utilizando facturación elástica.
      • PAIDMongoDB ha logrado cobrar a la tarjeta de crédito proporcionada.
      • PENDINGEsta factura incluye cargos por el ciclo de facturación actual.
      • PREPAID: El cliente tiene un plan prepagado, por lo que no se le cobrará.

      Los valores son PENDING, CLOSED, FORGIVEN, FAILED, PAID, FREE, PREPAID o INVOICED.

    • subtotalCents integer(int64)

      Suma de todos los conceptos de factura positivos incluidos en esta factura. Este parámetro expresa su valor en centavos (100a parte de un dólar estadounidense).

    • actualizado string(date-time)

      Fecha y hora en la que MongoDB Cloud actualizó por última vez el valor de este pago. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

  • 401 application/json

    No autorizado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      El código de error de la aplicación se devuelve con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 403 application/json

    Forbidden.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      El código de error de la aplicación se devuelve con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 404 application/json

    No se ha encontrado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      El código de error de la aplicación se devuelve con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 500 application/json

    Error interno del servidor.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      El código de error de la aplicación se devuelve con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

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"
Ejemplos de respuesta (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"
}
Ejemplos de respuesta (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
Ejemplos de respuesta (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"
}
Ejemplos de respuesta (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"
}
Ejemplos de respuesta (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"
}
Ejemplos de respuesta (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"
}