Nombre	Tipo	Necesidad	Descripción	predeterminado
Num. de pág.	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
elementosPorPágina	Número	Opcional	Número de elementos a devolver por página, hasta un máximo de 500.	`100`
bonito	booleano	Opcional	Indicador que especifica si el cuerpo de la respuesta debe tener un formato legible.	`false`
envelope	booleano	Opcional	Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes de API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure `envelope : true` en la consulta. Para los endpoints que devuelven una lista de resultados, el objeto `content` es un sobre. Cloud Manager añade el campo `status` al cuerpo de la respuesta.	`false`
backupJobsEnabledOnly	booleano	Opcional	Indicador que indica si se deben excluir los demonios que no están habilitados para hacer copias de seguridad de bases de datos de la respuesta. Establece esto en `false` para incluir las configuraciones del demonio con la bandera `backupJobsEnabled` establecida en `false`.	`true`

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Si configuras el elemento de query envelope en true, la respuesta estará envuelta en el objeto content.

La respuesta HTTP retorna un documento JSON que incluye los siguientes objetos:

Nombre

Tipo

Descripción

amountBilledCents

Número

Cantidad facturada en esta factura, calculada como subtotalCents + salesTaxCents - startingBalanceCents

amountPaidCents

Número

Cantidad pagada por esta factura.

created

string

Marca de tiempo en formato de fecha y hora ISO 8601 en UTC en la que se creó esta factura.

creditsCents

Número

Cantidad acreditada por MongoDB, en centavos de dólar estadounidenses.

endDate

string

Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando finalizó el período de facturación de esta factura.

groupId

string

Identificador único del proyecto con el que se asocia la factura. No aparece en todas las facturas.

id

string

Identificador único de esta factura.

lineItems

objeto arreglo

Partidas individuales en la factura. Esta información también se encuentra en la sección Usage Details de la página de facturas en la interfaz de usuario de Cloud Manager.

Cada objeto en el arreglo incluye los siguientes campos:

clusterName: El nombre del clúster que generó el cargo.
created: Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando se registró el elemento de línea en la factura.
endDate: Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando finalizó el período al que se aplica el elemento de línea.
discountCents: Importe descontado, en centavos de USD. Se muestra cuando corresponde.
groupId: ID del Proyecto al que está asociado el elemento de línea.
note: Nota sobre la partida.
percentDiscount: Porcentaje de descuento. Se muestra cuando corresponde.
quantity: Número de unidades del artículo de línea (como GB o horas).
replicaSetName: Nombre del set de réplicas al que está asociado el artículo.
sku: descripción de la partida. Esto podría ser el tipo de instancia, un cargo de soporte, seguridad avanzada, y demás.
startDate: Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando comenzó el período al que se aplica el elemento de línea.
totalPriceCents: Precio total del artículo de línea, en centavos de dólar estadounidense. Igual a
unitPriceDollars * quantity * 100
unitPriceDollars: Costo del artículo, en dólares.

links

objeto arreglo

Uno o más enlaces a subrecursos y/o recursos relacionados. Los tipos de relación entre las URLs se explican en la Especificación de Enlace Web.

orgId

string

Identificador único para la organización que recibió esta factura.

payments

objeto arreglo

Pagos aplicados a la factura. Los objetos en el arreglo payments incluyen los siguientes campos:

amountBilledCents: El importe de la factura, en centavos de dólar estadounidense.
amountPaidCents: El importe que pagó el cliente, en centavos de USD.
created: Marca de tiempo en formato de fecha y hora ISO 8601 en UTC de la fecha en que se registró el pago.
id: Identificador único del pago.
salesTaxCents: Importe del impuesto sobre las ventas pagado, en centavos de USD.
statusName: Estado del pago.
- CANCELLED: El pago se ha cancelado.
- FAILED: El intento de cobrar la tarjeta de crédito falló.
- FORGIVEN: Se creó el pago, pero se perdonó posteriormente.
- NEW: Se ha creado el pago, pero no se ha intentado cobrar la tarjeta de crédito.
- PAID: El pago fue exitoso.
subtotalCents: Suma de todos los elementos de línea de factura positivos, en centavos de USD.
updated: Marca de tiempo en formato de fecha y hora ISO 8601 en UTC en la que se actualizó por última vez el objeto.

refunds

objeto arreglo

Reembolsos emitidos para la factura. Los objetos en el arreglo refunds incluyen los siguientes campos:

amountCents: El importe del reembolso, en centavos de USD.
created: Marca de tiempo en formato de fecha y hora ISO 8601 en UTC de la fecha en que se registró el reembolso.
reason: Motivo del reembolso.
paymentId: Identificador único del pago.

salesTaxCents

Número

Cantidad de impuestos cobrados sobre subtotalCents.

startDate

string

Marca de tiempo en formato de fecha y hora ISO 8601 en UTC de la fecha de inicio de esta factura.

statusName

string

Estado de esta factura. Los valores aceptados son:

CLOSED: Se han liquidado todos los cargos del ciclo de suscripción, el saldo es superior a cero y al cliente aún no se le ha cobrado.
FAILED: No se pudo realizar el cobro a la tarjeta de crédito por el importe adeudado.
FORGIVEN: Se le ha cobrado al cliente, pero se ha perdonado el cobro.
FREE: El importe resultó ser cero, por lo que no se le cobra al cliente.
PAID: Los fondos se han transferido a MongoDB, Inc.
PENDING: Incluye cargos para el ciclo de suscripción actual. Un cliente nunca debe tener más de una factura en este estado.
PREPAID: El cliente tiene un plan de prepago, por lo que no se le cobra.

subtotalCents

Número

Suma de todas las partidas de facturas positivas en centavos de USD.

updated

string

Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando se actualizó por última vez la factura.

Solicitud de ejemplo

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invoices/pending

Respuesta de ejemplo

Nota

En la siguiente respuesta de ejemplo, el arreglo lineItems se ha truncado para facilitar su visualización.

{
  "amountBilledCents" : 0,
  "amountPaidCents" : 0,
  "created" : "2018-06-01T04:05:10Z",
  "endDate" : "2018-07-01T00:00:00Z",
  "id" : "{INVOICE-ID}",
  "lineItems" : [ {
    "clusterName" : "{CLUSTER-NAME}",
    "created" : "2018-06-19T04:06:14Z",
    "endDate" : "2018-06-19T00:00:00Z",
    "groupId" : "{PROJECT-ID}",
    "quantity" : 12.0,
    "replicaSetName": "rs0",
    "sku" : "CLOUD_MANAGER_BASIC",
    "startDate" : "2018-06-18T00:00:00Z",
    "totalPriceCents" : 31,
    "unitPriceDollars" : 0.026
  },
  ... ,
  {
    "clusterName" : "{CLUSTER-NAME}",
    "created" : "2018-06-19T04:06:14Z",
    "endDate" : "2018-06-19T00:00:00Z",
    "groupId" : "{PROJECT-ID}",
    "quantity" : 1.0,
    "replicaSetName": "rs0",
    "sku" : "BACKUP_STORAGE",
    "startDate" : "2018-06-18T00:00:00Z",
    "totalPriceCents" : 4,
    "unitPriceDollars" : 0.0351
  } ],
  "links" : [ {
    "href" : "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}",
    "rel" : "http://mms.mongodb.com/org"
  }, {
    "href" : "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invoices/{INVOICE-ID}",
    "rel" : "self"
  } ],
  "orgId" : "{ORG-ID}",
  "payments" : [ ],
  "refunds" : [ ],
  "salesTaxCents" : 0,
  "startDate" : "2018-06-01T00:00:00Z",
  "startingBalanceCents" : 0,
  "statusName" : "PENDING",
  "subtotalCents" : 0,
  "updated" : "2018-06-01T04:05:10Z"
}

Volver

Obtenga uno

Copia de seguridad y restauración