# List subscriptions

すべての定期サブスクリプションを一覧表示します。通知この API メソッドは高負荷時には使用できません。最大負荷は 1 分あたり 20 リクエストです。

  通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。

Endpoint: GET /merchants/{merchant_id}/subscriptions
Version: 2.0
Security: basicAuth

## Path parameters:

  - `merchant_id` (integer, required)
    マーチャントID。

## Query parameters:

  - `offset` (integer)
    リスト生成元のエレメントの番号です（カウントは0から始まります）。

  - `limit` (integer, required)
    ページにあるエレメント数の制限。

  - `user_id` (string)
    ユーザーID。

  - `project_id[]` (array)
    プロジェクトIDのリスト。

  - `plan_id[]` (array)
    サブスクリプションプランIDのリスト。

  - `product_id[]` (array)
    プランがリンクされている製品IDのリスト。

  - `group_id[]` (array)
    プランがリンクされているグループIDのリスト。

  - `status[]` (array)
    ステータス。
    Enum: "active", "canceled", "non_renewing"

  - `datetime_from` (string)
    サンプル日付。リクエストよりも後に作成されたサブスクリプションを見つけるのに役立ちます。

  - `datetime_to` (string)
    サンプル日付。リクエストよりも後に作成されたサブスクリプションを見つけるのに役立ちます。

## Response 200 fields (application/json):

  - `charge_amount` (number)
    請求額。

  - `comment` (string)
    サブスクリプション状態を変更する理由

  - `currency` (string)
    購入通貨。ISO 4217に基づく3文字の通貨コード。

  - `date_create` (string)
    [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)に基づくYYYY-MM-DD’T’HH:MM:SSフォーマットのサブスクリプション作成日。

  - `date_end` (string)
    [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)に基づくYYYY-MM-DD’T’HH:MM:SSフォーマットのサブスクリプション終了日。

  - `date_last_charge` (string,null)
    [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)に基づくYYYY-MM-DD’T’HH:MM:SSフォーマットのサブスクリプション最終請求日。

  - `date_next_charge` (string,null)
    [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)に基づくYYYY-MM-DD’T’HH:MM:SSフォーマットの次回のサブスクリプション請求日。

  - `id` (integer)
    サブスクリプションID

  - `plan` (object)

  - `plan.billing_retry` (object)
    請求再試行の詳細。

  - `plan.billing_retry.value` (integer, required)
    請求の再試行回数。

  - `plan.charge` (object)
    請求の詳細。

  - `plan.charge.amount` (number)
    請求額。

  - `plan.charge.currency` (string)
    購入通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)に準拠した3文字の通貨コード。

  - `plan.charge.period` (object, required)
    請求期間。

  - `plan.charge.period.type` (string, required)
    時間の単位。day、monthまたはlifetimeにすることができます。
    Enum: "day", "month", "lifetime"

  - `plan.charge.period.value` (integer, required)
    時間単位の数。値はタイプパラメータに依存し、次のようになります：-typeはdayの場合 、1から366まで-typeはmonthの場合、1から12まで、-typeはlifetimeの場合、０です

  - `plan.charge.prices` (array)
    異なる通貨での価格を一覧表示します。

  - `plan.charge.prices.setup_fee` (number)
    最初の請求書の一部として請求される1回のセットアップ費用。

  - `plan.description` (object)
    プランの説明文。"localization":"plan description"のペアで構成されます。

  - `plan.description.ar` (string)
    アラビア語。

  - `plan.description.bg` (string)
    ブルガリア語。

  - `plan.description.cn` (string)
    中国語（簡体字）。

  - `plan.description.cs` (string)
    チェコ語。

  - `plan.description.de` (string)
    ドイツ語。

  - `plan.description.en` (string)
    英語。

  - `plan.description.es` (string)
    スペイン語。

  - `plan.description.fr` (string)
    フランス語。

  - `plan.description.he` (string)
    ヘブライ語。

  - `plan.description.it` (string)
    イタリア語。

  - `plan.description.ja` (string)
    日本語。

  - `plan.description.ko` (string)
    韓国語。

  - `plan.description.pl` (string)
    ポーランド語。

  - `plan.description.pt` (string)
    ポルトガル語。

  - `plan.description.ro` (string)
    ルーマニア語。

  - `plan.description.ru` (string)
    ロシア語。

  - `plan.description.th` (string)
    タイ語。

  - `plan.description.tr` (string)
    トルコ語。

  - `plan.description.tw` (string)
    中国語（繁体字）。

  - `plan.description.vi` (string)
    ベトナム語。

  - `plan.expiration` (object)
    サブスクリプションの有効期限の詳細。

  - `plan.expiration.type` (string, required)
    時間の単位。dayまたはmonthにすることができます。
    Enum: "day", "month"

  - `plan.expiration.value` (integer,null, required)
    有効期間。

  - `plan.external_id` (string)
    プラン外部ID（32文字）。

  - `plan.grace_period` (object)
    猶予期間の詳細。

  - `plan.grace_period.type` (string, required)
    時間の単位。dayにすることができます。
    Enum: "day"

  - `plan.grace_period.value` (integer, required)
    時間単位の数。

  - `plan.group_id` (string,null)
    プランがリンクされているグループID。

  - `plan.id` (integer)
    サブスクリプションプラン ID。

  - `plan.name` (object)
    プラン名。"localization":"plan name"のペアで構成されます。

  - `plan.project_id` (integer)
    プロジェクトID。

  - `plan.refund_period` (integer,null)
    ユーザーがサブスクリプションプランの支払いを返金できる期間（日単位）。

  - `plan.status` (object)

  - `plan.status.value` (string)
    サブスクリプションプランのステータス
    Enum: "active", "disabled"

  - `plan.tags` (array)
    プランのタグ。

  - `plan.trial` (object)
    試用期間の詳細。

  - `product` (object,null)

  - `product.id` (integer,null)
    プランがリンクされている製品のID。

  - `product.description` (object)
    ローカライズされたアイテムの説明。

  - `product.group_id` (string)
    製品がリンクされているグループID。

  - `product.name` (string)
    製品名。

  - `status` (string)
    状態
    Enum: "new", "active", "canceled", "non_renewing", "freeze"

  - `user` (object)

  - `user.id` (string)
    ユーザーID

  - `user.name` (string)
    ユーザー名