Subscriptions API (2.0)
OpenAPI記述をダウンロード
言語
サーバー
Mock server
https://xsolla.redocly.app/_mock/ja/api/subscriptions/
- https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/subscriptions
- Mock serverhttps://xsolla.redocly.app/_mock/ja/api/subscriptions/merchants/{merchant_id}/subscriptions
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/ja/api/subscriptions/merchants/{merchant_id}/subscriptions?offset=0&limit=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'OK。
ISO 8601に基づくYYYY-MM-DD’T’HH:MM:SSフォーマットのサブスクリプション作成日。
ISO 8601に基づくYYYY-MM-DD’T’HH:MM:SSフォーマットのサブスクリプション終了日。
ISO 8601に基づくYYYY-MM-DD’T’HH:MM:SSフォーマットのサブスクリプション最終請求日。
ISO 8601に基づくYYYY-MM-DD’T’HH:MM:SSフォーマットの次回のサブスクリプション請求日。
ローカライズされたアイテムの説明。
レスポンス
application/json
[ { "charge_amount": 0.03, "currency": "USD", "date_create": "2013-09-05T15:27:47+04:00", "date_end": "2014-02-06T11:32:48+04:00", "date_last_charge": null, "date_next_charge": null, "id": 45, "plan": { … }, "product": { … }, "status": "canceled", "user": { … } } ]
- https://api.xsolla.com/merchant/v2/projects/{project_id}/subscriptions/{subscription_id}
- Mock serverhttps://xsolla.redocly.app/_mock/ja/api/subscriptions/projects/{project_id}/subscriptions/{subscription_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/ja/api/subscriptions/projects/{project_id}/subscriptions/{subscription_id}'OK。
ISO 8601に基づくYYYY-MM-DD’T’HH:MM:SSフォーマットのサブスクリプション作成日。
ISO 8601に基づくYYYY-MM-DD’T’HH:MM:SSフォーマットのサブスクリプション終了日。
ISO 8601に基づくYYYY-MM-DD’T’HH:MM:SSフォーマットのサブスクリプション最終請求日。
ISO 8601に基づくYYYY-MM-DD’T’HH:MM:SSフォーマットの次回のサブスクリプション請求日。
ローカライズされたアイテムの説明。
レスポンス
application/json
{ "charge_amount": 0.03, "comment": "The subscription was not extended in due time", "currency": "USD", "date_create": "2018-09-21T16:54:59+03:00", "date_end": "2019-02-06T12:43:04+03:00", "date_last_charge": "2018-09-21T16:55:05+03:00", "date_next_charge": "2018-09-21T16:55:05+03:00", "id": 249579, "plan": { "external_id": "lowcost", "id": 601 }, "product": { "id": 123456 }, "status": "canceled", "user": { "id": "user1", "name": "John Smith" } }
ボディapplication/json必須
trueに設定すると、このサブスクリプションで最後に支払った決済分が払い戻されます。canceledに設定したステータスと共にのみ実行できます。
請求の延期。
コラボレーター ID — インフルエンサーまたはアフィリエイトネットワーク識別子。あなたのアドミンページ>パートナーネットワーク>インフルエンサーセクションで見つけることができます。
- https://api.xsolla.com/merchant/v2/projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}
- Mock serverhttps://xsolla.redocly.app/_mock/ja/api/subscriptions/projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/ja/api/subscriptions/projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}' \
-H 'Content-Type: application/json' \
-d '{
"status": "active"
}'レスポンス
application/json
{ "charge_amount": 0.03, "currency": "USD", "date_create": "2018-09-21T16:54:59+03:00", "date_end": null, "date_last_charge": "2018-09-21T16:55:05+03:00", "date_next_charge": "2018-09-21T16:55:05+03:00", "id": 24953579, "plan": { "billing_retry": { … }, "charge": { … }, "description": null, "expiration": { … }, "external_id": "lowcost", "grace_period": { … }, "group_id": "newPlans", "id": 66001, "localized_name": null, "name": null, "project_id": 18404, "refund_period": null, "status": { … }, "tags": null, "trial": { … }, "type": "all" }, "product": null, "status": "active", "user": { "id": "jb1", "name": "J.Black" } }