Get Subscriptions

Get SubscriptionsServer-sideAdmin

get/merchants/{merchant_id}/subscriptions

Lists all recurrent subscriptions.

Notice

This API method can’t be used under a high load. The maximum load is 20 requests per minute.

Notice

This API call does not contain the project_id path-parameter, so you need to use the API key that is valid in all the company’s projects to set up authorization.

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

Response samples

application/json

[{"id": 45,
"status": "canceled",
"user": {"id": "User1",
"name": "John Smith"
},
"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,
"plan": {"id": 12345,
"project_id": 12345
},
"product": {"id": null
}
}
]