Xsolla-logo

Get Subscriptions

get/merchants/{merchant_id}/subscriptions

Lists all recurrent subscriptions.

Note

This API endpoint can't be used under high load. When the number of requests is high, rate limits may apply. Contact your Account Manager to find out the rate limits for this API endpoint.

SecuritybasicAuth
Request
path Parameters
merchant_id
required
integer

Merchant ID.

query Parameters
limit
required
integer

Limit for the number of elements on the page.

offset
integer

Number of the element from which the list is generated (the count starts from 0).

user_id
string

User ID.

project_id[]
Array of integers

List of project IDs.

plan_id[]
Array of integers

List of subscription plan IDs.

product_id[]
Array of integers

List of product IDs the plans are linked to.

group_id[]
Array of strings

List of group IDs the plans are linked to.

status[]
Array of strings

Status.

Items Enum: "active" "canceled" "non_renewing"
datetime_from
string <datetime>

Sample date. Use this to find subscriptions created later than the request.

datetime_to
string <datetime>

Sample date. Use this to find subscriptions created later than the request.

Responses
200

OK.

Request samples
curl -i -X GET \
  -u <username>:<password> \
  '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
[
  • {
    }
]