billing

PUT `/v1/billing/payment-preferences`

Elect (or stop) paying by crypto.

Նույնականացում

Ուղարկեք API բանալին որպես bearer token: Բանալին պետք է ունենա billing.payment.manage թույլտվությունը. առանց դրա բանալին մերժվում է 403, և ոչ թե 404 կարգավիճակով:

Որտեղ տեղադրվում է ձեր կազմակերպության ID-ն

Այs վերջնակետը ընդունում է org_id-ը որպես հարցման պարամետր: Բաց թողեք այն, և կանչը կընդգրկի ձեր ամբողջ վարձակալության ենթածառը. ուղարկեք այն՝ կանչը մեկ կազմակերպության վրա սահմանափակելու համար:

Ձեր կազմակերպության ID-ն գտնվում է Ձեր ղեկավարման վահանակի API բանալիների էկրանին՝ բուն բանալու կողքին: Այն նույն ID-ն է Ձեր կատարած յուրաքանչյուր հարցման մեջ:

Փորձել

Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:

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

Մուտք գործե՞լ եք: Ձեր վահանակի API վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ API-ի դեմ, որպեսզի կարողանաք տեսնել փաստացի պատասխանը: Բացեք այս վերջնակետը API վահանակում

Մանրամասներ

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.

Պարամետրեր

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`org_id (query)`	`Uuid`	Ոչ	The organization to update. Omitted or empty means the caller's own.

Հարցման մարմին

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`pays_by_crypto`	`boolean`	Այո	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…

Պատասխան

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`org_id`	`string`	Այո	—
`pays_by_crypto`	`boolean`	Այո	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`	Այո	The mandate charged first, or `null` if none is nominated or usable.
`backup_payment_method_id`	`string`	Այո	The mandate charged if the primary declines.
`auto_renew_possible`	`boolean`	Այո	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`	Այո	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…

Այս վերջնակետի կողմից վերադարձվող սխալները

401 · 403 · 409 · 422

PUT /v1/billing/payment-preferences