第23章 請求設定の定義

本項では、Red Hat 3scale API Management での請求機能の仕組みについて説明します。

請求設定は Charging & Gateway および Credit Card Policies からなり、共に管理ポータルの Audience > Billing で設定することができます。

23.1. Mode (Charging & Gateway)

3scale での請求は暦月に基づき、前払い および 後払い の設定が可能です。

  • 前払いモードでは、すべての固定費および開設費が月の初めまたはあん分した請求期間の初めに請求されます。変動費は、必ず翌月の初めに計算され請求されます。
  • 後払いモードでは、すべての固定費および変動費が翌月の初めに請求されます。

詳細については、「自動請求プロセス」を参照してください。

23.2. Charging enabled (Charging & Gateway)

この設定により、クレジットカードを使用した支払いが有効になります。このチェックボックスが選択されていると、期限を迎えたすべての請求書に対する課金が、選択した支払いゲートウェイを使用して行われます。このチェックボックスを未選択のままにすると、請求が行われ請求書は発行されますが、実際の支払い行為は発生しません。

23.3. Currency (Charging & Gateway)

請求およびクレジットカードによる支払いを行う際の通貨を選択します。選択した通貨が支払いゲートウェイでサポートされていることを確認してください。これはグローバルな設定で、すべての請求書および支払いに適用されます。開発者アカウントごとに異なる通貨を設定することはできません。

23.4. Invoice footnote (Charging & Gateway)

Invoice footnote フィールドに入力されたテキストは、すべての PDF ファイルの請求書の最下部に表示されます。このフィールドを使用して、顧客の課金および請求ポリシーに関する補足情報を提供することができます。

脚注のテキストが変更されても、PDF ファイルがすでに生成されている請求書には自動的に適用されません。ただし、請求書の PDF ファイルを再生成することにより、変更を適用することが可能です。

23.5. Text to show if VAT/Sales Tax is 0% (Charging & Gateway)

請求を行うアカウントの VAT/消費税が 0% の場合に、このフィールドを使用して PDF ファイルの請求書にテキストメッセージを追加します。この行は、VAT/消費税が明示的に 0 に設定されている場合にのみ表示され、それ以外の場合には表示されません。このテキストは、管理ポータルの Invoice のページにも表示されます。

この設定の詳細については、「VAT レート/消費税」セクションを参照してください。

23.6. 通貨用 YAML の設定

currencies.yml ファイルにより、3scale デプロイメントの通貨リストを設定することができます。3scale では、ISO 4217 に基づく 3 文字の通貨コードが使用されます。

重要
  • 選択した通貨が支払いゲートウェイでサポートされるようにしてください。
  • 3scale では、クレジットカードによる支払いに関して以下の支払いゲートウェイとのインテグレーションが提供されます。

    • Braintree
    • Stripe

23.6.1. OpenShift での通貨設定の変更

通貨設定を変更するには、以下の手順を実施します。

手順

  1. system config map のエントリーとして、currencies.yml の新しいコンテンツのソースを追加します。デフォルトの通貨リストに新たな通貨 ARS: アルゼンチンペソ を追加する方法を、以下の例で説明します。

    oc patch configmap system --type merge -p "{\"data\": {\"currencies.yml\": \"production:\n  'USD - American Dollar': 'USD'\n  'EUR - Euro': 'EUR'\n  'GBP - British Pound': 'GBP'\n  'NZD - New Zealand dollar': 'NZD'\n  'CNY - Chinese Yuan Renminbi': 'CNY'\n  'CAD - Canadian Dollar': 'CAD'\n  'AUD - Australian Dollar': 'AUD'\n  'JPY - Japanese Yen': 'JPY'\n  'CHF - Swiss Franc': 'CHF'\n  'SAR - Saudi Riyal': 'SAR'\n  'ARS - Argentine peso': 'ARS'\n\"}}"
    注記

    currencies.yml 設定ファイルのコンテンツの例を確認するには、デフォルトの YAML ファイル currencies.yml にアクセスします。このファイルは、新規 3scale デプロイメントのデフォルト設定を示します。

    base: &default
      'USD - American Dollar': 'USD'
      'EUR - Euro': 'EUR'
      'GBP - British Pound': 'GBP'
      'NZD - New Zealand dollar': 'NZD'
      'CNY - Chinese Yuan Renminbi': 'CNY'
      'CAD - Canadian Dollar': 'CAD'
      'AUD - Australian Dollar': 'AUD'
      'JPY - Japanese Yen': 'JPY'
      'CHF - Swiss Franc': 'CHF'
      'SAR - Saudi Riyal': 'SAR'
    production:
      <<: *default
    preview:
      <<: *default
  2. system-(app|sidekiq) DeploymentConfigsystem-config ボリュームに、新規 ConfigMap エントリー currencies.yml を追加します。これにより、新しいコンテンツが該当するコンテナー内にマウントされ、新しい設定がアクティベートされます。

    export PATCH_SYSTEM_VOLUMES='{"spec":{"template":{"spec":{"volumes":[{"configMap":{"items":[{"key":"zync.yml","path":"zync.yml"},{"key":"rolling_updates.yml","path":"rolling_updates.yml"},{"key":"service_discovery.yml","path":"service_discovery.yml"},{"key":"currencies.yml","path":"currencies.yml"}],"name":"system"},"name":"system-config"}]}}}}'
    oc patch dc system-app -p $PATCH_SYSTEM_VOLUMES
    oc patch dc system-sidekiq -p $PATCH_SYSTEM_VOLUMES
    unset PATCH_SYSTEM_VOLUMES

23.6.2. 新しい通貨の確認

3scale 管理ポータルで通貨が利用できることを確認するには、以下の手順を実施します。

手順

  1. Audience > Billing > Charging & Gateway の順に移動します。
  2. Currency ドロップダウンリストから通貨のリストが利用できることを確認します。
  3. 使用する通貨を選択します。

23.7. Billing periods for invoice ids (Charging & Gateway)

3scale の請求書には、2 種類の ID があります。

実際の ID
データベース内で請求書を一意に識別する。数値による ID で、請求書の URL に使用される (例: https://<dashboard_domain>/buyers/accounts/<acount_id>/invoices/<invoice_id>) と共に、Billing API で請求書 ID として使用されます。
平易な ID
請求書に表示される、人間にとって分かりやすい ID。平易な ID が重複していても技術的には問題ありませんが、3scale アカウント内で一意にすべきです。3scale が ID の重複を感知すると、This invoice id is already in use and should probably be changed のような警告メッセージが表示されます。平易な ID が 24 時間以上 fix と表示される場合には、サポートにご連絡ください。

以下の設定により、請求書の平易な ID のフォーマットを定義します。

monthly (デフォルト)
YYYY-MM-XXXXXXXX: ID には、年、月、および請求書の番号が含まれます。たとえば 2018-02-00000013 というフォーマットになります。
yearly
YYYY-XXXXXXXX: 年および番号だけが含まれます。たとえば 2018-00000001 というフォーマットになります。

Billing periods for invoice identifiers を monthly から yearly に変更しても、平易な ID のフォーマットが変わるだけです。この変更により、請求サイクルの期間が変わることはありません。3scale API Management でサポートされるのは、月額の請求だけです。経理部門からそのような指示があった場合には、請求書 ID のフォーマットを yearly に変更します。

顧客に対して年額の課金を行う必要がある場合には、請求を手作業で処理する必要があります。新たな請求書を作成し、年額の費用項目を追加することができます。年額の課金を希望する場合には、毎月請求書の生成や課金が自動的に行われないように、アプリケーションプランを無料に設定する必要もあります。

23.8. Credit Card Policies

ここでは、以下のページへのパスを設定することができます。

  • 契約条項のページ
  • プライバシーポリシーのページ
  • 払い戻しポリシーのページ