Skip to content

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

Subscriptions

Operations

Payments

Operations

Promotions

Operations

Coupons

Operations

Subscriptions

Operations

Catalog

Operations

Coupons

Operations

Subscriptions

Operations

Payment accounts

Operations

Get payment account

Request

Security
managementJwtAuth
Path
subscription_idinteger\d+required
project_idinteger\d+required
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/api/subscriptions/api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_account' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Get payment account info

Bodyapplication/json
idintegerrequired
Example: "123"
typestringrequired
Example: "card"
namestring or null
Example: "** 7398"
card_expiry_dateobject or null
card_expiry_date.​yearstring
Example: "2023"
card_expiry_date.​monthstring
Example: "09"
ps_namestring or null
Example: "Mastercard"
switch_icon_namestring or null
Example: "mastercard.svg"
Response
application/json
{
  "id": "123",
  "type": "card",
  "name": "** 7398",
  "card_expiry_date": {
    "year": "2023",
    "month": "09"
  },
  "ps_name": "Mastercard",
  "switch_icon_name": "mastercard.svg"
}

Manage payment account

Request

Security
managementJwtAuth
Path
subscription_idinteger\d+required
project_idinteger\d+required
Bodyapplication/json
sandboxboolean or null
curl -i -X POST \
  'https://xsolla.redocly.app/_mock/api/subscriptions/api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_account/manage' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "sandbox": true
  }'

Responses

Returns link for managing payment accounts

Bodyapplication/json
link_to_psstringrequired
Example: "https://secure.xsolla.com/paystation2/?access_token=<access_token>"
Response
application/json
{
  "link_to_ps": "https://secure.xsolla.com/paystation2/?access_token=<access_token>"
}

List payment accounts

Request

Security
managementJwtAuth
Path
subscription_idinteger\d+required
project_idinteger\d+required
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/api/subscriptions/api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_accounts' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Returns the user's billing accounts

Bodyapplication/json
itemsArray of objects
Default []
items[].​idintegerrequired
Example: "12345"
items[].​namestring or null
Example: "PP_saved_account"
items[].​payment_system(object or null)
(object or null)
items[].​typestring or null
Example: "paypal"
Response
application/json
{
  "items": []
}