Obter a fatura de um mês

Retorna os detalhes de cobrança de um mês selecionado.

Recupera os dados de faturamento do mês solicitado.

Verifique se a resposta tem ok === "BILL_FOUND" antes de usar seus campos de faturamento. Uma fatura ausente ou uma consulta malsucedida retorna error: "BILL_NOT_FOUND" com HTTP 200, portanto o status HTTP sozinho não comprova que uma fatura foi encontrada.

O parâmetro de caminho billYearMonth está no formato YYYY-MM. Por exemplo, para recuperar sua fatura de março de 2019 você usaria 2019-03.

Exemplo de requisição

Defina BILL_YEAR_MONTH com o valor do seu recurso sem aplicar codificação percentual.

Workspaces cancelados não podem criar novos tokens bearer. Este endpoint continua disponível com uma Auth Key ativa existente: use a receita de faturamento assinada em vez da configuração de token abaixo. A chave precisa conceder os escopos exigidos por este endpoint.

Execute esta requisição em um shell no lado do servidor com curl e um token bearer adequado em TRANSLOADIT_TOKEN. Se você precisar de um token, expanda a configuração abaixo.

if ! TOKEN_RESPONSE="$(curl --fail-with-body -sS \
  --request POST \
  --url 'https://api2.transloadit.com/token' \
  --user "${TRANSLOADIT_KEY:?Set TRANSLOADIT_KEY}:${TRANSLOADIT_SECRET:?Set TRANSLOADIT_SECRET}" \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'grant_type=client_credentials' \
  --data-urlencode 'aud=api2' \
  --data-urlencode 'scope=billing:read')"; then
  printf '%s\n' "$TOKEN_RESPONSE" >&2
  exit 1
fi
TRANSLOADIT_TOKEN="$(printf '%s' "$TOKEN_RESPONSE" |
  jq -er '.access_token | strings | select(length > 0)')" || exit 1

curl --fail-with-body -sS --request GET --get \
  --url "https://api2.transloadit.com/bill/${BILL_YEAR_MONTH:?Set BILL_YEAR_MONTH}" \
  --header "Authorization: Bearer ${TRANSLOADIT_TOKEN:?Set TRANSLOADIT_TOKEN}" \
  --data-urlencode 'params={}'

Este endpoint aceita params assinados ou um token bearer. Consulte Autenticação para instruções de configuração.

Escopo necessário para a Auth Key ou o token bearer: billing:read.

Requisições assinadas exigem tanto uma signature quanto um timestamp params.auth.expires no futuro. Tokens Bearer não exigem nenhum dos dois.

Os campos de autenticação desta lista se aplicam a requisições assinadas. Com um bearer token, você pode omitir params.auth e o campo signature separado. Compare os parâmetros de requisição específicos de autenticação abaixo.

Acesso à cobrança após o cancelamento

Workspaces cancelados não podem criar novos bearer tokens. Para obter as faturas deles, use uma requisição assinada com uma Auth Key ativa já existente e o respectivo Auth Secret, em vez da configuração de token descrita acima. A chave ainda precisa conceder o escopo listado para este endpoint.

O SDK Node.js assina as requisições de cobrança diretamente; ele não chama /token. Em um projeto Node.js confiável no lado do servidor, instale-o com yarn add @transloadit/node. Defina TRANSLOADIT_KEY, TRANSLOADIT_SECRET e BILL_YEAR_MONTH (por exemplo, 2026-08) no ambiente. Mantenha o secret no seu backend.

Este exemplo de SDK usa sha384, o padrão para chaves de API recém-criadas. Se a sua chave usar outro algoritmo de assinatura, siga a Signature Authentication com esse algoritmo configurado.

Salve o conteúdo a seguir como bill.mjs e execute node bill.mjs:

import { Transloadit } from '@transloadit/node'

const { TRANSLOADIT_KEY, TRANSLOADIT_SECRET, BILL_YEAR_MONTH } = process.env
if (!TRANSLOADIT_KEY || !TRANSLOADIT_SECRET || !BILL_YEAR_MONTH) {
  throw new Error('Set TRANSLOADIT_KEY, TRANSLOADIT_SECRET, and BILL_YEAR_MONTH')
}

const transloadit = new Transloadit({
  authKey: TRANSLOADIT_KEY,
  authSecret: TRANSLOADIT_SECRET,
})
const bill = await transloadit.getBill(BILL_YEAR_MONTH)
if (bill.ok !== 'BILL_FOUND') throw new Error('No bill was returned')
console.log(JSON.stringify(bill, null, 2))

O invoice_id é null para o mês atual.