Список подписок

Xsolla Developers

или

Список подписокServer-sideAdmin

get/merchants/{merchant_id}/subscriptions

Выводит список всех повторяющихся подписок.

Внимание

Этот метод API нельзя использовать при высокой нагрузке. Максимальная нагрузка составляет 20 запросов в минуту.

Внимание

Этот метод API не включает в себя path-параметр 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"
}
}
]