Удаление плана

Subscriptions API (2.0)
Копировать для LLM
Копировать страницу как Markdown для LLM
Просмотреть как Markdown
Открыть эту страницу как Markdown
Открыть в ChatGPT
Получить анализ от ChatGPT
Открыть в Claude
Получить инсайты от Claude

Введение

Версия: 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/

Токен
Копировать для LLM
Копировать страницу как Markdown для LLM
Просмотреть как Markdown
Открыть эту страницу как Markdown
Открыть в ChatGPT
Получить анализ от ChatGPT
Открыть в Claude
Получить инсайты от Claude

Операции

Планы
Копировать для LLM
Копировать страницу как Markdown для LLM
Просмотреть как Markdown
Открыть эту страницу как Markdown
Открыть в ChatGPT
Получить анализ от ChatGPT
Открыть в Claude
Получить инсайты от Claude

Операции

Обновление плана

Запрос

Изменение параметров рекуррентного плана.

Безопасность

basicAuth

Путь

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

ID проекта.

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

ID рекуррентного плана.

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

billing_retryobject

Данные о попытках списания средств.

chargeobject

Объект с данными о рекуррентном списании.

descriptionobject

Описание плана. Значение состоит из пар "localization":"plan description".

expirationobject

Информация об истечении срока подписки.

external_idstring

Внешний идентификатор плана.

grace_periodobject

Время периода отсрочки.

group_idstring

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

nameobject

Название плана. Значение состоит из пар "localization":"plan name".

refund_periodinteger or null

Период, в течение которого пользователь может вернуть средства, потраченные на план подписки (в днях).

statusobject

tagsArray of strings

Теги плана.

trialobject

Информация о пробном (триальном) периоде. Если параметр не передан, используются значения по умолчанию (0 дней).

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/subscriptions/projects/{project_id}/subscriptions/plans/{plan_id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "billing_retry": {
      "value": 1
    },
    "charge": {
      "amount": 20,
      "currency": "USD",
      "period": {
        "type": "month",
        "value": 1
      },
      "prices": [
        {
          "amount": 17,
          "currency": "EUR",
          "setup_fee": 1.5
        },
        {
          "amount": 2000,
          "currency": "JPY",
          "setup_fee": 2.5
        }
      ]
    },
    "description": {
      "en": "3x more experience!"
    },
    "expiration": {
      "type": "day",
      "value": null
    },
    "external_id": "exp",
    "grace_period": {
      "type": "day",
      "value": 2
    },
    "name": {
      "en": "Experience boost"
    },
    "refund_period": null,
    "tags": [],
    "trial": {
      "type": "day",
      "value": 7
    }
  }'

Ответы

OK.

Телоapplication/json

Ответ

application/json

{
  "billing_retry": {
    "value": 1
  },
  "charge": {
    "amount": 20,
    "currency": "USD",
    "period": { … },
    "prices": [ … ]
  },
  "description": {
    "en": "3x more experience!"
  },
  "expiration": {
    "type": "day",
    "value": 0
  },
  "external_id": "exp",
  "grace_period": {
    "type": "day",
    "value": 2
  },
  "group_id": null,
  "id": 241082,
  "localized_name": "Experience boost",
  "name": {
    "en": "Experience boost"
  },
  "project_id": 40797,
  "refund_period": null,
  "status": {
    "value": "active"
  },
  "tags": [],
  "trial": {
    "type": "day",
    "value": 7
  },
  "type": "all"
}