サブスクリプションを管理する

顧客のゾーンをプロビジョニングしたあと、ゾーンおよびアカウントレベルのサブスクリプションを追加できます。

ゾーンサブスクリプションを作成します。通常は、ゾーンのプランを PARTNERS_FREE から有料の Zone プラン にアップグレードするために使います。/zones/{zone_id}/subscription エンドポイントに POST リクエストを送信し、次の値を含めます。

• rate_plan オブジェクト

  • お客様がダッシュボードで注文するゾーンプランに対応します。利用可能な値の一覧は ゾーンサブスクリプション を参照してください。

• component_values 配列

  • リセラー契約に応じた追加サービスです。追加の page_rules などがあります。

• frequency 文字列

  • サブスクリプションを自動更新する頻度です（デフォルトは "monthly"）。

curl 'https://api.cloudflare.com/client/v4/zones/{zone_id}/subscription' \
--header "Authorization: Bearer <API_TOKEN>" \
--header "Content-Type: application/json" \
--data '{
  "rate_plan": {
    "id": "<RATE_PLAN>"
  },
  "frequency": "annual"
}'

curl 'https://api.cloudflare.com/client/v4/zones/{zone_id}/subscription' \
--header "Authorization: Bearer <API_TOKEN>" \
--header "Content-Type: application/json" \
--data '{
  "rate_plan": {
    "id": "PARTNERS_BIZ"
  },
  "component_values": [
    {
      "name": "page_rules",
      "value": 50
    }
  ]
}

ゾーンサブスクリプションの詳細を取得するには、/zones/<ZONE_ID>/subscription エンドポイントへ GET リクエストを送ります。

ゾーンのサブスクリプションを更新するには（既存サブスクリプションの component_values の更新や、ゾーンサブスクリプションのダウングレードでよく使います）、/zones/<ZONE_ID>/subscription エンドポイントへ PUT リクエストを送ります。

契約内容によっては、ほかのアドオンサービスを再販できます。これらはアカウントレベルのサブスクリプションとしてプロビジョニングします。

アカウントサブスクリプションを作成するには、/accounts/{account_id}/subscriptions エンドポイントへ POST リクエストを送り、次の値を含めます。

• rate_plan object

  • 特定のアドオンサービスに対応するアカウントサブスクリプションです。利用できる値の一覧は 利用できるサブスクリプション を参照してください。

• component_values array

  • リセラー契約に応じた追加サービスです。例として、Load Balancing の追加エンドポイントや Cloudflare Zero Trust の追加シートがあります。含めない場合、サブスクリプションには各購入に関連するデフォルト値が入ります。

• frequency string

  • サブスクリプションが自動更新される間隔です（デフォルトは "monthly"）。

curl 'https://api.cloudflare.com/client/v4/accounts/{account_id}/subscriptions' \
--header "Authorization: Bearer <API_TOKEN>" \
--header "Content-Type: application/json" \
--data '{
  "rate_plan": {
    "id": "<RATE_PLAN_NAME>"
  }
}'

アカウントの全サブスクリプションを取得するには、/accounts/<ACCOUNT_ID>/subscriptions エンドポイントへ GET リクエストを送ります。

アカウントのサブスクリプションを更新するには、/accounts/<ACCOUNT_ID>/subscriptions/<SUBSCRIPTION_ID> エンドポイントへ PUT リクエストを送ります。

アカウントのサブスクリプションを削除するには、/accounts/<ACCOUNT_ID>/subscriptions/<SUBSCRIPTION_ID> エンドポイントへ DELETE リクエストを送ります。