billing

GET /v1/billing/payment-preferences

How this account intends to pay.

Alle billing-eindpunten

Authenticatie

Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.

Waar je organisatie-id komt te staan

Dit eindpunt accepteert org_id als queryparameter. Laat deze achterwege en de aanroep destilleert je gehele tenant-substructie; stuur deze mee om de aanroep te beperken tot één organisatie.

Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

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

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

Details

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.

Parameters

NaamTypeVerplichtWat dit is
org_id (query)UuidNeeThe organization to read. Omitted or empty means the caller's own.

Reactie

NaamTypeVerplichtWat dit is
org_idstringJa
pays_by_cryptobooleanJaThe 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_idstringJaThe mandate charged first, or `null` if none is nominated or usable.
backup_payment_method_idstringJaThe mandate charged if the primary declines.
auto_renew_possiblebooleanJaWhether 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_reachablebooleanJaWhether 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…

Fouten die dit eindpunt kan retourneren

401 · 403