サブスクリプションと請求
顧客のプランを販売、変更、終了し、カードへの請求内容を確認します。
各顧客のワークスペースは、販売するティアのサブスクリプションを1つ持つことができます。すべてのワークスペースの請求書は、リセラーのカードで支払われます。ワークスペースの現在のサブスクリプションは、has_payment_issueとともにworkspaces.listのsubscriptionフィールドに格納されています。
プランを割り当てる
まだプランがないワークスペースをプランに加入させます。billing_periodにはmonthly_period(デフォルト)またはannual_periodを指定します。
プランを割り当てたり変更したりするたびに、生成したidempotency_keyを送信します。リクエストがタイムアウトした場合も、同じキーで再試行すれば、ワークスペースが重複してプランに加入したり、二重に請求されたりすることはありません。
has_payment_issueがtrueの間は、プランの割り当てや変更が拒否されます。再試行する前に、未払いの請求書を顧客に提示するか、そのpay_urlから支払ってください。
プランを変更する
subscriptions.changeはassignと同じリクエストボディを受け取ります。
- アップグレードはすぐに適用されます。
- ダウングレードまたは同レベルのティアへの変更は、請求期間の終了時に適用されます。それまでは、サブスクリプションの
pending_downgrade_tierに新しいティア、pending_downgrade_at_unixに適用日が表示されます。
ワークスペースを現在のティアのまま維持するには、subscriptions.cancel_pending_downgradeで予定されているダウングレードを取り消します。
ダウングレードが適用されると、新しいプランの上限を超える受付担当者と電話番号は無効になり、チーム人数の上限を超えるメンバーは一時停止されます。
プランを終了する
subscriptions.unassignは、現在の請求期間の終了時にサブスクリプションを終了します。それまでは、cancel_at_unixに終了日時が表示されます。subscriptions.restoreで解約を取り消すと、プランは通常どおり更新されます。
請求書
カードへの各請求は、1つのワークスペースの請求書に対する支払いです。billing.list_invoicesは、請求書を新しい順に1ページずつ返します。請求書のstatusは次のいずれかです。
billing.get_invoiceでは、請求書のlinesも返されます。amount_centsが負の明細は日割り計算によるクレジットで、明細の合計は常に請求額と一致します。
今後の支払い
billing.list_upcoming_paymentsは、各ワークスペースの次回更新時の支払い見込みを、期日が近い順に返します。plan_usdは更新時に前払いで請求されるプラン料金です。ダウングレードが予定されている場合は、ダウングレード後のティアの料金になります。overage_so_far_usdは、現在の請求期間で、これまでに含まれる分数を超えて利用した分の料金です。この料金は更新時に請求され、それまでは利用に応じて増え続けます。