Obter todas as faturas de uma organização

Nesta página

Resource

Parâmetros do caminho da solicitação
Solicitar parâmetros de query
Parâmetros do corpo da solicitação
Resposta
Exemplo de solicitação
Exemplo de resposta

O Cloud Manager não oferecerá mais suporte para Automação, Backup e Monitoramento do MongoDB 3.6 e 4.0 após 30 de agosto de 2024. Faça upgrade da sua versão do MongoDB ou migre para o Atlas.

A autenticação OAuth 2.0 para acesso programático ao Cloud Manager está disponível como um recurso de visualização.: O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para usar a autenticação OAuth 2.0 , crie umaconta de serviço para usar em suas solicitações para a API pública do Cloud Manager .

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

Resource

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

Parâmetros do caminho da solicitação

Nome	Tipo	Descrição
`ORG-ID`	string	Identificador único da organização.

Solicitar parâmetros de query

Os seguintes parâmetros de query são opcionais:

Nome	Tipo	necessidade	Descrição	Default
pageNum	número	Opcional	Um inteiro baseado que retorna uma subseção de resultados.	`1`
itemsPerPage	número	Opcional	Número de itens a serem devolvidos por página, até um máximo de 500.	`100`
pretty	booleano	Opcional	Sinalizador que indica se o corpo da resposta deve estar em um prettyprint formato.	`false`
envelope	booleano	Opcional	Sinalizador que indica se deseja ou não envolver a resposta em um envelope. Alguns clientes do API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure `envelope : true` na consulta. Para endpoints que retornam uma lista de resultados, o objeto `content` é um envelope. O Cloud Manager adiciona o campo `status` ao corpo da resposta.	`false`
backupJobsEnabledOnly	booleano	Opcional	Sinalizador que indica se os daemon não habilitados para reconhecimento de data center devem ser excluídos da resposta. Defina isso como `false` para incluir configurações de daemon com o sinalizador `backupJobsEnabled` definido como `false`.	`true`

Parâmetros do corpo da solicitação

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

Resposta

Cada documento no array result representa uma fatura. Normalmente, as cobranças são publicadas no dia seguinte.

Nome

Tipo

Descrição

amountBilledCents

número

Valor cobrado nesta fatura, calculado como subtotalCents + salesTaxCents - startingBalanceCents.

amountPaidCents

número

Valor pago para esta fatura, em centavos de USD.

created

string

Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando esta fatura foi criada.

creditsCents

número

Valor acreditado pelo MongoDB, em centavos de USD.

endDate

string

Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando o período de faturamento desta fatura terminou.

id

string

Identificador único para esta fatura.

links

array de objetos

Um ou mais links para sub-recursos e/ou recursos relacionados. Os tipos de relação entre URLs são explicados na Especificação de links da web .

groupId

string

Identificador único do projeto ao qual a fatura está associada. Não aparece em todas as faturas.

orgId

string

Identificador único da organização que recebeu esta fatura.

salesTaxCents

número

Valor dos impostos cobrados sobre subtotalCents.

startDate

string

Carimbo de data/hora na ISO 8601 formato de data e hora em UTC da data de início desta fatura.

statusName

string

Estado desta fatura. Os valores aceitos são:

Status	Descrição
`CLOSED`	Todas as cobranças do ciclo de assinatura foram finalizadas, o saldo é maior que zero e a cobrança do cliente ainda não foi efetuada.
`FAILED`	Houve uma falha ao tentar cobrar o valor devido do cartão de crédito.
`FORGIVEN`	O cliente foi cobrado, mas a cobrança foi perdoada.
`FREE`	O valor acabou sendo zero, então o cliente não é cobrado.
`PAID`	Os recursos foram transferidos para a MongoDB, Inc.
`PENDING`	Inclui cobranças para o ciclo de assinatura atual. Um cliente nunca deve ter mais de uma fatura nesse estado.
`PREPAID`	O cliente está em um plano pré-pago, portanto, o cliente não é cobrado.

subtotalCents

número

Soma de todos os itens de linha da fatura positiva em centavos de USD.

updated

string

Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando a fatura foi atualizada pela última vez.

Exemplo de solicitação

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invoices/?pretty=true"

Exemplo de resposta

{
   "links" : [ {
     "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invoices/?pretty=true&pageNum=1&itemsPerPage=100",
     "rel" : "self"
   } ],
   "results" : [ {
     "amountBilledCents" : 0,
     "amountPaidCents" : 0,
     "created" : "2018-06-01T04:05:10Z",
     "endDate" : "2018-07-01T00:00:00Z",
     "id" : "{INVOICE-ID}",
     "links" : [ {
       "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invoices/{INVOICE-ID}",
       "rel" : "self"
     } ],
     "orgId" : "{ORG-ID}",
     "salesTaxCents" : 0,
     "startDate" : "2018-06-01T00:00:00Z",
     "startingBalanceCents" : 0,
     "statusName" : "PENDING",
     "subtotalCents" : 0,
     "updated" : "2018-06-01T04:05:10Z"
   }, {
     "amountBilledCents" : 726,
     "amountPaidCents" : 726,
     "created" : "2018-02-01T06:05:04Z",
     "endDate" : "2018-03-01T00:00:00Z",
     "id" : "{INVOICE-ID}",
     "links" : [ {
       "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invoices/{INVOICE-ID}",
       "rel" : "self"
     } ],
     "orgId" : "{ORG-ID}",
     "salesTaxCents" : 57,
     "startDate" : "2018-02-01T00:00:00Z",
     "startingBalanceCents" : 0,
     "statusName" : "PAID",
     "subtotalCents" : 669,
     "updated" : "2018-03-01T07:00:54Z"
   } ],
   "totalCount" : 16
}

Voltar

Faturas

Obter uma fatura da organização