Récupérer la facture d’un mois

Renvoie les détails de facturation pour le mois sélectionné.

Récupère les données de facturation pour le mois demandé.

Vérifiez que la réponse contient ok === "BILL_FOUND" avant d’utiliser ses champs de facturation. Une facture absente ou un échec de recherche renvoie error: "BILL_NOT_FOUND" avec un statut HTTP 200. Le statut HTTP seul ne permet donc pas de déterminer qu’une facture a été trouvée.

Le paramètre de chemin billYearMonth est au format YYYY-MM. Par exemple, pour récupérer votre facture de mars 2019, utilisez 2019-03.

Exemple de requête

Définissez BILL_YEAR_MONTH sur la valeur de votre ressource sans l’encoder en pourcentage.

Les Workspaces résiliés ne peuvent pas créer de nouveaux jetons porteurs. Ce point de terminaison reste accessible avec une Auth Key active existante : utilisez la procédure de facturation avec signature au lieu de la configuration du jeton ci-dessous. La clé doit accorder les portées requises par ce point de terminaison.

Exécutez cette requête dans un shell côté serveur avec curl et un jeton porteur approprié dans TRANSLOADIT_TOKEN. Si vous avez besoin d’un jeton, développez la section de configuration ci-dessous.

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={}'

Ce point de terminaison accepte des params signés ou un jeton porteur. Consultez la section Authentification pour les instructions de configuration.

Portée requise pour l’Auth Key ou le jeton porteur : billing:read.

Les requêtes signées nécessitent à la fois une signature et un horodatage params.auth.expires situé dans le futur. Les jetons porteurs ne nécessitent ni l’un ni l’autre.

Les champs d’authentification de cette liste s’appliquent aux requêtes signées. Avec un jeton porteur, vous pouvez omettre params.auth et le champ distinct signature. Comparez les paramètres de requête spécifiques à l’authentification ci-dessous.

Accès à la facturation après résiliation

Les Workspaces résiliés ne peuvent pas créer de nouveaux jetons porteurs. Pour récupérer leurs factures, utilisez une requête signée avec une Auth Key existante et active et son Auth Secret au lieu de la configuration de jeton ci-dessus. La clé doit toujours accorder la portée indiquée pour ce point de terminaison.

Le SDK Node.js signe directement les requêtes de facturation ; il n’appelle pas /token. Dans un projet Node.js côté serveur de confiance, installez-le avec yarn add @transloadit/node. Définissez TRANSLOADIT_KEY, TRANSLOADIT_SECRET et BILL_YEAR_MONTH (par exemple, 2026-08) dans l’environnement. Conservez le secret sur votre backend.

Cet exemple avec le SDK utilise sha384, la valeur par défaut pour les clés API nouvellement créées. Si votre clé utilise un autre algorithme de signature, suivez plutôt les instructions de Signature Authentication avec cet algorithme configuré.

Enregistrez le code suivant dans bill.mjs et exécutez 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))

La valeur de invoice_id est null pour le mois en cours.