Obter uma fatura da organização
Nesta página
URL base: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /orgs/{ORG-ID}/invoices/{INVOICE-ID}
Parâmetros do caminho da solicitação
Nome | Tipo | Descrição |
---|---|---|
ORG-ID | string | Identificador único da organização. |
INVOICE-ID | string | Identificador único da fatura. Normalmente, as cobranças são publicadas no dia seguinte. |
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 Para endpoints que retornam uma lista de resultados, o objeto | 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
Se você definir o elemento de query envelope
como true
, a resposta será envolvida pelo objeto content
.
A resposta HTTP retorna um JSON document que inclui os seguintes objeto:
Nome | Tipo | Descrição | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
amountBilledCents | número | Valor cobrado nesta fatura, calculado como subtotalCents + salesTaxCents - initialBalanceCents | ||||||||||||||||||||||||||||||
amountPaidCents | número | Valor pago para esta fatura. | ||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||
groupId | string | Identificador único do projeto ao qual a fatura está associada. Não aparece em todas as faturas. | ||||||||||||||||||||||||||||||
id | string | Identificador único para esta fatura. | ||||||||||||||||||||||||||||||
lineItems | array de objetos | Itens de linha na fatura. Essas informações também são encontradas na seção Usage Details da página Fatura na interface do usuário do Cloud Manager. Cada objeto na array inclui os seguintes campos:
| ||||||||||||||||||||||||||||||
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 . | ||||||||||||||||||||||||||||||
orgId | string | Identificador único da organização que recebeu esta fatura. | ||||||||||||||||||||||||||||||
payments | array de objetos | Pagamentos aplicados à fatura. Os objetos na array
| ||||||||||||||||||||||||||||||
refunds | array de objetos | Reembolsos emitidos para a fatura. Os objetos na array
| ||||||||||||||||||||||||||||||
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:
| ||||||||||||||||||||||||||||||
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 \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invoices/{INVOICE-ID}"
Exemplo de resposta
Observação
Na resposta de exemplo a seguir, a array lineItems
foi truncada para facilitar a visualização.
{ "amountBilledCents" : 240, "amountPaidCents" : 240, "created" : "2018-04-01T06:14:31Z", "endDate" : "2018-05-01T00:00:00Z", "id" : "{INVOICE-ID}", "lineItems" : [ { "clusterName" : "{CLUSTER-NAME}", "created" : "2018-05-01T04:05:31Z", "endDate" : "2018-05-01T00:00:00Z", "groupId" : "{PROJECT-ID}", "quantity" : 72.0, "replicaSetName": "rs0", "sku" : "CLOUD_MANAGER_BASIC", "startDate" : "2018-04-30T00:00:00Z", "totalPriceCents" : 0, "unitPriceDollars" : 0.0 }, { "clusterName" : "{CLUSTER-NAME}", "created" : "2018-04-30T04:05:19Z", "endDate" : "2018-04-30T00:00:00Z", "groupId" : "{PROJECT-ID}", "quantity" : 72.0, "replicaSetName": "rs0", "sku" : "CLOUD_MANAGER_BASIC", "startDate" : "2018-04-29T00:00:00Z", "totalPriceCents" : 0, "unitPriceDollars" : 0.0 }, ... , { "clusterName" : "{CLUSTER-NAME}", "created" : "2018-04-02T06:05:07Z", "endDate" : "2018-04-02T00:00:00Z", "groupId" : "{PROJECT-ID}", "quantity" : 72.0, "replicaSetName": "rs0", "sku" : "CLOUD_MANAGER_BASIC", "startDate" : "2018-04-01T00:00:00Z", "totalPriceCents" : 0, "unitPriceDollars" : 0.0 } ], "links" : [ { "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}", "rel" : "http://mms.mongodb.com/org" }, { "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invoices/{INVOICE-ID}", "rel" : "self" } ], "orgId" : "{ORG-ID}", "payments" : [ { "amountBilledCents" : 240, "amountPaidCents" : 240, "created" : "2018-05-01T04:05:14Z", "id" : "{PAYMENT-ID}", "salesTaxCents" : 19, "statusName" : "PAID", "subtotalCents" : 221, "updated" : "2018-05-01T07:00:46Z" } ], "refunds" : [ ], "salesTaxCents" : 19, "startDate" : "2018-04-01T00:00:00Z", "startingBalanceCents" : 0, "statusName" : "PAID", "subtotalCents" : 221, "updated" : "2018-05-01T07:00:46Z"