billing

GET /v1/billing/payment-preferences

How this account intends to pay.

Tutti gli endpoint billing

Autenticazione

Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.

L'ID della tua organizzazione va qui

Questo endpoint accetta org_id come parametro di query. Omettilo e la chiamata coprirà l'intero sottoalbero del tuo tenant; invialo per limitare la chiamata a una singola organizzazione.

L'identificativo della tua organizzazione si trova nella schermata delle chiavi API nella tua dashboard, accanto alla chiave stessa. È lo stesso identificativo in ogni chiamata che effettui.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

curl -X GET https://api.zinndigital.com/v1/billing/payment-preferences \
  -H "Authorization: Bearer zdk_live_…"

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

The crypto election, the nominated primary/backup, and the two derived answers a billing screen must not compute for itself: whether the account can be charged unattended at all, and whether its backup could actually catch the primary's decline. ⛔ Deliberately **not** part of `GET/PUT /v1/billing/profile`, even though it reads and writes the same row. That endpoint is a documented **full replace**, so folding the crypto election into it would mean a customer correcting a typo in their billing address silently switched their account off crypto — surfacing a month later as an unpaid invoice, with nothing in between to notice it.

Parametri

NomeTipoObbligatorioChe cos'è
org_id (query)UuidNoThe organization to read. Omitted or empty means the caller's own.

Risposta

NomeTipoObbligatorioChe cos'è
org_idstring
pays_by_cryptobooleanThe account pays in crypto (NOWPayments). Satisfies the "at least one operational payment method" floor with no card on file, and moves the account to **invoice-ahead** renewal…
primary_payment_method_idstringThe mandate charged first, or `null` if none is nominated or usable.
backup_payment_method_idstringThe mandate charged if the primary declines.
auto_renew_possiblebooleanWhether this account can be charged unattended at all. `false` for a crypto-only account, and for one whose only mandates are rails Stripe will not let us reuse — both renew by…
fallback_reachablebooleanWhether the nominated backup could actually catch the primary's decline. `false` when there is no backup, or when it sits on a **different gateway** — a charge resolves one gate…

Errori che questo endpoint può restituire

401 · 403