Skip to content
/
Get Payments

Subscriptions API (2.0)

Overview

  • Version: 2.0
  • Servers: https://api.xsolla.com/merchant/v2/

This API reference describes endpoints for managing subscriptions, coupons, and promotions. To get more information about Subscriptions, see the product guide and the glossary.

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Mock server
https://xsolla.redocly.app/_mock/api/subscriptions/

Token

Operations

Plans

Operations

Products

Operations

Subscription management

Operations

Payments

Operations

Get Payments

Request

Lists all subscription payments.

Security
basicAuth
Path
project_idintegerrequired

Project ID.

Query
offsetinteger

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

limitintegerrequired

Limit for the number of elements on the page.

user_idstring

User ID.

statusstring

Transaction status.

Enum ValueDescription
done

Payment was successfully processed.

fail

Payment was not processed successfully, or refund was issued.

datetime_fromstring(datetime)

Period start.

datetime_tostring(datetime)

Period end.

subscription_idinteger

Subscription ID.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/api/subscriptions/projects/{project_id}/subscriptions/payments?offset=0&limit=0&user_id=string&status=done&datetime_from=string&datetime_to=string&subscription_id=0'

Responses

OK.

Bodyapplication/json
Response
application/json
[
  {
    "date_payment": "2016-04-05T10:02:01+03:00",
    "id": 67683,
    "id_payment": 203960,
    "status": "fail",
    "subscription": { … }
  },
  {
    "date_payment": "2015-09-21T17:06:47+03:00",
    "id": 1531,
    "id_payment": 168866,
    "status": "done",
    "subscription": { … }
  }
]

Get User Payments

Request

Lists all payments made by a specific user.

Security
basicAuth
Path
project_idintegerrequired

Project ID.

user_idstringrequired

User ID.

Query
statusstring

Transaction status.

Enum ValueDescription
done

Payment was successfully processed.

fail

Payment was not processed successfully, or refund was issued.

offsetinteger

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

limitintegerrequired

Limit for the number of elements on the page.

datetime_fromstring(datetime)

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

datetime_tostring(datetime)

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

subscription_idinteger

Subscription ID.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/api/subscriptions/projects/{project_id}/users/{user_id}/subscriptions/payments?status=done&offset=0&limit=0&datetime_from=string&datetime_to=string&subscription_id=0'

Responses

OK.

Bodyapplication/json
Response
application/json
[
  {
    "date_payment": "2016-04-05T10:02:01+03:00",
    "id": 6746083,
    "id_payment": 202789960,
    "status": "fail",
    "subscription": { … }
  }
]

Get Currencies

Request

Lists all supported subscription currencies.

Security
basicAuth
Path
project_idintegerrequired

Project ID.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/api/subscriptions/projects/{project_id}/subscriptions/currencies'

Responses

OK.

Bodyapplication/json
Response
application/json
[
  "AED",
  "ALL",
  "AMD",
  "ARS",
  "AUD",
  "AZN",
  "BAM",
  "BBD",
  "BGN",
  "BHD",
  "BND",
  "BRL",
  "BYN",
  "BZD",
  "CAD",
  "CHF",
  "CLP",
  "CNY",
  "COP",
  "CRC",
  "CZK",
  "DKK",
  "DZD",
  "EGP",
  "EUR",
  "GBP",
  "GEL",
  "GHS",
  "GIP",
  "GTQ",
  "HKD",
  "HRK",
  "HUF",
  "IDR",
  "ILS",
  "INR",
  "IQD",
  "IRR",
  "ISK",
  "JMD",
  "JOD",
  "JPY",
  "KES",
  "KGS",
  "KRW",
  "KWD",
  "KZT",
  "LAK",
  "LBP",
  "LKR",
  "MAD",
  "MDL",
  "MKD",
  "MMK",
  "MNT",
  "MUR",
  "MXN",
  "MYR",
  "NGN",
  "NIO",
  "NOK",
  "NPR",
  "NZD",
  "OMR",
  "PAB",
  "PEN",
  "PHP",
  "PKR",
  "PLN",
  "PYG",
  "QAR",
  "RON",
  "RSD",
  "RUB",
  "SAR",
  "SEK",
  "SGD",
  "SVC",
  "THB",
  "TND",
  "TRY",
  "TWD",
  "UAH",
  "USD",
  "UYU",
  "UZS",
  "VEF",
  "VND",
  "XOF",
  "YER",
  "ZAR"
]

Promotions

Operations

Coupons

Operations

Subscription management

Operations