billing

PUT `/v1/billing/payment-preferences`

Elect (or stop) paying by crypto.

Autenticazione

Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione billing.payment.manage; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.

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 PUT https://api.zinndigital.com/v1/billing/payment-preferences \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "pays_by_crypto": <boolean> }'

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

Requires `billing.payment.manage` — the same key that gates adding and removing a payment method, because this **is** a payment-method decision. ⛔ Not `billing.invoice.manage`: it changes what we can charge, not what prints on an invoice. Turning crypto **off** answers `409` when it is currently the only way the account can be charged and something is still going to charge it. The floor is on the resulting **state**, not on one of the two actions that can breach it — otherwise a customer could satisfy it with crypto, delete their last card, then switch crypto off.

Parametri

Nome	Tipo	Obbligatorio	Che cos'è
`org_id (query)`	`Uuid`	No	The organization to update. Omitted or empty means the caller's own.

Corpo della richiesta

Nome	Tipo	Obbligatorio	Che cos'è
`pays_by_crypto`	`boolean`	Sì	Elect (or stop) paying by crypto. ⛔ Turning it off is refused with `409` when crypto is currently the only way the account can be charged and something is still going to cha…

Risposta

Nome	Tipo	Obbligatorio	Che cos'è
`org_id`	`string`	Sì	—
`pays_by_crypto`	`boolean`	Sì	The 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_id`	`string`	Sì	The mandate charged first, or `null` if none is nominated or usable.
`backup_payment_method_id`	`string`	Sì	The mandate charged if the primary declines.
`auto_renew_possible`	`boolean`	Sì	Whether 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_reachable`	`boolean`	Sì	Whether 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 · 409 · 422