認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/billing/payment-preferences \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
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.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
org_id (query) | Uuid | いいえ | The organization to read. Omitted or empty means the caller's own. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
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