/ /

/ /

Obtener factura pendiente de una organización

Cloud Manager dejará de ofrecer compatibilidad con automatización, copias de seguridad y monitorización para MongoDB 3.6 y 4.0 a partir del 30de agosto de 2024. Por favor, Actualice su implementación de MongoDB o migre a Atlas.

URL base: https://cloud.mongodb.com/api/public/v1.0

Resource

GET /orgs/{ORG-ID}/invoices/pending

Parámetros de la ruta de solicitud

Nombre	Tipo	Descripción
`ORG-ID`	string	Identificador único de la organización.

Parámetros de consulta de solicitud

Los siguientes parámetros de consulta son opcionales:

Nombre	Tipo	Necesidad	Descripción	predeterminado
número de página	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
artículos por página	Número	Opcional	Número de artículos a devolver por página, hasta un máximo de 500.	`100`
bonita	booleano	Opcional	Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato.	`false`
envolvente	booleano	Opcional	Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos Los clientes de laAPI 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`
trabajos de respaldo habilitados solamente	booleano	Opcional	Indicador que indica si se deben excluir de la respuesta los daemons no habilitados para realizar copias de seguridad de bases de datos. Establezca este valor en `false` para incluir las configuraciones de daemon con el indicador `backupJobsEnabled` establecido en `false`.	`true`

Parámetros del cuerpo de la solicitud

Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.

Respuesta

Si establece el elemento de consulta envelope en true, la respuesta estará envuelta por el objeto content.

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

Nombre

Tipo

Descripción

amountBilledCents

Número

Importe facturado en esta factura, calculado como subtotalCents + salesTaxCents - initialBalanceCents

amountPaidCents

Número

Importe pagado por esta factura.

created

string

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

creditsCents

Número

Cantidad acreditada por MongoDB, en centavos de USD.

endDate

string

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

groupId

string

Identificador único del proyecto asociado a la factura. No aparece en todas las facturas.

id

string

Identificador único para esta factura.

lineItems

matriz de objetos

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

Cada objeto de la matriz incluye los siguientes campos:

Item

Descripción

clusterName

El nombre del grupo que generó el cargo

created

Marca de tiempo en formato ISO,8601 fecha y hora en UTC cuando se publicó la línea de artículo en la factura.

endDate

Marca de tiempo en formato ISO 8601 de fecha y hora en UTC cuando finalizó el período al que se aplica la línea de artículo.

discountCents

Importe descontado, en centavos de dólar. Se muestra cuando corresponde.

groupId

ID del proyecto con el que está asociada la línea de artículo.

note

Nota sobre la partida del rubro.

percentDiscount

Porcentaje de descuento. Se muestra cuando corresponde.

quantity

Número de unidades de la línea de pedido (por ejemplo, GB, horas, etc.).

replicaSetName

Nombre del conjunto de réplicas con el que está asociado el elemento de línea.

sku

Descripción de la partida. Puede ser el tipo de instancia, un cargo por soporte, seguridad avanzada, etc.

startDate

Marca de tiempo en formato ISO 8601 de fecha y hora en UTC cuando comenzó el período al que se aplica la línea de artículo.

totalPriceCents

Precio total del artículo de línea, en centavos de USD. Igual a

 unitPriceDollars * quantity * 100

unitPriceDollars

Costo del artículo, en dólares.

links

matriz de objetos

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

orgId

string

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

payments

matriz de objetos

Pagos aplicados a la factura. Los objetos de la matriz payments incluyen los siguientes campos:

Campo

Descripción

amountBilledCents

El importe de la factura, en centavos de USD.

amountPaidCents

El monto que pagó el cliente, en centavos de USD.

created

Marca de tiempo en formato ISO 8601 fecha y hora en UTC de la fecha en que se registró el pago.

id

Identificador único del pago.

salesTaxCents

Monto del impuesto sobre las ventas pagado, en centavos de USD.

statusName

Estado del pago.

Estado	Descripción
`CANCELLED`	El pago ha sido cancelado.
`FAILED`	El intento de cargar la tarjeta de crédito falló.
`FORGIVEN`	El pago fue creado, pero posteriormente fue condonado.
`NEW`	Se ha creado el pago, pero no se ha intentado cargar la tarjeta de crédito.
`PAID`	El pago fue exitoso

subtotalCents

Suma de todas las líneas de factura positivas, en centavos de USD.

updated

Marca de tiempo en formato ISO,8601 fecha y hora en UTC en que se actualizó el objeto por última vez.

refunds

matriz de objetos

Reembolsos emitidos para la factura. Los objetos de la matriz refunds incluyen los siguientes campos:

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

salesTaxCents

Número

Importe de los impuestos aplicados al subtotalCents.

startDate

string

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

statusName

string

Estado de esta factura. Los valores aceptados son:

Estado	Descripción
`CLOSED`	Se han finalizado todos los cargos del ciclo de suscripción, el saldo es más que cero y aún no se ha cobrado al cliente.
`FAILED`	No se pudo realizar el cobro a la tarjeta de crédito por el monto adeudado.
`FORGIVEN`	Se le ha cobrado al cliente, pero el cargo le ha sido perdonado.
`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 los cargos del ciclo de suscripción actual. Un cliente nunca debe tener más de una factura en este estado.
`PREPAID`	El cliente tiene un plan prepago, por lo que no se le cobra.

subtotalCents

Número

Suma de todas las líneas de factura positivas en centavos de USD.

updated

string

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

Ejemplo de solicitud

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

Ejemplo de respuesta

Nota

En la siguiente respuesta de muestra, la matriz lineItems se ha truncado para facilitar la 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

Consigue uno

Copia de seguridad y restauración