billing

PUT `/v1/billing/payment-preferences`

Elect (or stop) paying by crypto.

प्रमाणीकरण

एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। कुञ्जीसँग billing.payment.manage अनुमति हुनुपर्छ; अनुमति नभएको कुञ्जीलाई 404 होइन, 403 मार्फत अस्वीकार गरिन्छ।

तपाईंको संस्थाको आइडी राख्ने ठाउँ

यो इन्डपोइन्टले org_id लाई क्वेरी प्यारामिटरको रूपमा लिन्छ। यसलाई छुटाउनुभयो भने कलले तपाईंको सम्पूर्ण टेनेन्सी सबट्रीलाई समेट्छ; यसलाई एउटा संस्थामा मात्र सीमित गर्न पठाउनुहोस्।

तपाईंको संस्थाको आइडी (ID) तपाईंको ड्यासबोर्डमा रहेको API कुञ्जीहरू (keys) स्क्रिनमा, कुञ्जीको छेउमा हुन्छ। तपाईंले गर्ने प्रत्येक कलमा यही आइडी प्रयोग हुन्छ।

प्रयास गर्नुहोस्

कोणीय कोष्ठकभित्र भएका जुनसुकै कुरालाई आफ्नो मानहरूद्वारा बदल्नुहोस्, र मुख्य स्थानहोल्डरलाई तपाईंको ड्यासबोर्डको कुञ्जीद्वारा बदल्नुहोस्।

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 कन्सोलले तपाईंको वास्तविक संस्थाको आईडी र आफ्नै कुञ्जी भरिदिन्छ, र लाइभ 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 cha…

प्रतिक्रिया

नाम	प्रकार	आवश्यक	यो के हो
`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 gate…

यो इन्डपोइन्टले फर्काउन सक्ने त्रुटिहरू

401 · 403 · 409 · 422

PUT /v1/billing/payment-preferences