Перейти к содержимому

Введение

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

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

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

Запрос

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.

Запрос

Updates a subscription-based product.

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

ID проекта.

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

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

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

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

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

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

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

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

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/subscriptions/projects/{project_id}/subscriptions/products/{product_id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": {
      "en": "Description in English."
    },
    "group_id": "charge13",
    "name": "Channel23"
  }'

Ответы

OK.

Телоapplication/json
idinteger or null

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

descriptionobject

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

group_idstring

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

namestring

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

Ответ
application/json
{ "description": { "en": "Description in English." }, "group_id": "charge13", "id": 1713603, "name": "Channel23" }
Операции
Операции
Операции
Операции
Операции