Recuperar la factura de un mes

Devuelve los detalles de facturación del mes seleccionado.

Obtiene los datos de facturación del mes solicitado.

Comprueba que la respuesta tenga ok === "BILL_FOUND" antes de usar sus campos de facturación. Si no existe la factura o falla la consulta, se devuelve error: "BILL_NOT_FOUND" con HTTP 200, por lo que el estado HTTP por sí solo no demuestra que se haya encontrado una factura.

El parámetro de ruta billYearMonth tiene el formato YYYY-MM. Por ejemplo, para obtener tu factura de marzo de 2019 usarías 2019-03.

Ejemplo de solicitud

Asigna a BILL_YEAR_MONTH el valor de tu recurso sin aplicarle codificación porcentual.

Los Workspaces cancelados no pueden crear nuevos tokens Bearer. Este endpoint sigue estando disponible con una Auth Key activa existente: usa la guía de facturación firmada en lugar de la configuración del token que se muestra a continuación. La clave debe conceder los ámbitos requeridos por este endpoint.

Ejecuta esta solicitud en una shell del lado del servidor con curl y un token Bearer adecuado en TRANSLOADIT_TOKEN. Si necesitas un token, despliega la configuración que aparece a continuación.

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 acepta params firmados o un token Bearer. Consulta Autenticación para ver las instrucciones de configuración.

Ámbito requerido para el Auth Key o el token de portador: billing:read.

Las solicitudes firmadas requieren tanto una signature como una marca de tiempo futura en params.auth.expires. Los tokens Bearer no requieren ninguno de estos dos elementos.

Los campos de autenticación de esta lista se aplican a las solicitudes firmadas. Con un token Bearer puedes omitir params.auth y el campo separado signature. Compara a continuación los parámetros de solicitud de cada método de autenticación.

Acceso a la facturación tras la cancelación

Los Workspaces cancelados no pueden crear nuevos tokens Bearer. Para recuperar sus facturas, usa una solicitud firmada con una Auth Key existente y activa y su Auth Secret en lugar de la configuración del token anterior. La clave debe seguir concediendo el ámbito indicado para este endpoint.

El SDK de Node.js firma las solicitudes de facturación directamente; no llama a /token. En un proyecto de Node.js de confianza del lado del servidor, instálalo con yarn add @transloadit/node. Define TRANSLOADIT_KEY, TRANSLOADIT_SECRET y BILL_YEAR_MONTH (por ejemplo, 2026-08) en el entorno. Mantén el secreto en tu backend.

Este ejemplo del SDK usa sha384, el valor predeterminado para las claves de API recién creadas. Si tu clave usa otro algoritmo de firma, sigue Signature Authentication con ese algoritmo configurado en su lugar.

Guarda lo siguiente como bill.mjs y ejecuta 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))

El valor de invoice_id es null para el mes actual.