サブスクリプションの一覧

Xsolla Developers

または

パブリッシャーアカウントへ

サブスクリプションの一覧Server-sideAdmin

get/merchants/{merchant_id}/subscriptions

すべての定期サブスクリプションを一覧表示します。

通知

この API メソッドは高負荷時には使用できません。最大負荷は 1 分あたり 20 リクエストです。

通知

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

SecuritybasicAuth

Request

path Parameters

merchant_id

required

integer

マーチャントID。

query Parameters

limit required	integer ページにあるエレメント数の制限。
offset	integer リスト生成元のエレメントの番号です（カウントは0から始まります）。
user_id	string ユーザーID。
project_id[]	Array of integers プロジェクトIDのリスト。
plan_id[]	Array of integers サブスクリプションプランIDのリスト。
product_id[]	Array of integers プランがリンクされている製品IDのリスト。
group_id[]	Array of strings プランがリンクされているグループIDのリスト。
status[]	Array of strings ステータス。 Items Enum: "active" "canceled" "non_renewing"
datetime_from	string <datetime> サンプル日付。リクエストよりも後に作成されたサブスクリプションを見つけるのに役立ちます。
datetime_to	string <datetime> サンプル日付。リクエストよりも後に作成されたサブスクリプションを見つけるのに役立ちます。

Responses

200

OK。

Request samples

curl -i -X GET \
  -u <merchant_id>:<api_key> \
  'https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/subscriptions?limit=0&offset=0&user_id=string&project_id%5B%5D=0&plan_id%5B%5D=0&product_id%5B%5D=0&group_id%5B%5D=string&status%5B%5D=active&datetime_from=string&datetime_to=string'

Response samples

application/json

[{"charge_amount": 0.03,
"currency": "USD",
"date_create": "2013-09-05T15:27:47+0400",
"date_end": "2014-02006T11:32:48+0400",
"date_last_charge": null,
"date_next_charge": null,
"id": 45,
"plan": {"id": 12345,
"project_id": 12345
},
"product": {"id": null
},
"status": "canceled",
"user": {"id": "User1",
"name": "John Smith"
}
}
]