Перейти к содержимому
/
Создание продукта

Subscriptions API (2.0)

Введение

  • Версия: 2.0
  • Серверы: https://api.xsolla.com/merchant/v2/

Этот справочник API описывает методы для управления подписками, купонами и акциями. Подробная информация о продукте Subscriptions приведена в руководстве по продукту и глоссарии.

Скачать описание OpenAPI
index.json
index.yaml
Языки
Серверы
Mock server
https://xsolla.redocly.app/_mock/ru/api/subscriptions/

Токен

Операции

Планы

Операции

Продукты

Операции

Список продуктов

Запрос

Lists all subscription-based products.

Безопасность
basicAuth
Путь
project_idintegerобязательный

ID проекта.

Запрос
offsetinteger

Номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0).

limitintegerобязательный

Лимит количества элементов на странице.

group_idstring

ID группы, к которой привязаны планы.

product_idinteger

ID продукта, к которому привязаны планы.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/subscriptions/projects/{project_id}/subscriptions/products?offset=0&limit=0&group_id=string&product_id=0'

Ответы

OK.

Телоapplication/jsonArray [
idinteger or null

ID продукта, к которому привязаны планы.

descriptionobject

Локализованные описания предметов.

group_idstring

ID группы, к которой привязан план.

namestring

Название продукта.

]
Ответ
application/json
[
  {
    "description": { … },
    "group_id": "charge",
    "id": 714,
    "name": "Channel"
  },
  {
    "description": { … },
    "group_id": "notify",
    "id": 715,
    "name": "notify"
  },
  {
    "description": { … },
    "group_id": "charge",
    "id": 716,
    "name": "charge2"
  },
  {
    "description": { … },
    "group_id": "charge",
    "id": 486,
    "name": "Channel2"
  }
]

Создание продукта

Запрос

Creates a subscription-based product.

Безопасность
basicAuth
Путь
project_idintegerобязательный

ID проекта.

Телоapplication/jsonобязательный
descriptionobject

Локализованные описания предметов.

group_idstringобязательный

ID группы, к которой привязан план.

namestringобязательный

Название продукта.

curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/subscriptions/projects/{project_id}/subscriptions/products' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": {
      "en": "Kids TV"
    },
    "group_id": "charge",
    "name": "Channel2"
  }'

Ответы

Created.

Телоapplication/json
product_idinteger
Ответ
application/json
{
  "product_id": 172003
}

Удаление продукта

Запрос

Deletes a subscription-based product.

Безопасность
basicAuth
Путь
project_idintegerобязательный

ID проекта.

product_idintegerобязательный

ID продукта, к которому привязаны планы.

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

Ответы

No content.

Subscription management

Операции

Платежи

Операции

Акции

Операции

Купоны

Операции

Subscription management

Операции