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

Обновление планаServer-sideAdmin

put/projects/{project_id}/subscriptions/plans/{plan_id}

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

SecuritybasicAuth

Request

path Parameters

project_id required	integer ID проекта.
plan_id required	integer ID рекуррентного плана.

Request Body schema: application/json

object

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

value

required

integer

Количество попыток списания.

object

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

required

object

Расчетный период.

value

required

integer

Количество временных единиц. Значение зависит от типа параметра и может быть:
- от 1 до 366, если параметр type принимает значение day;
- от 1 до 12, если параметр type принимает значение month;
- 0 если параметр type принимает значение lifetime.

type

required

string

Единица времени. Может принимать значения day, month или lifetime.

Enum: "day" "month" "lifetime"

amount

number <float>

Сумма рекуррентного списания.

currency

string

Валюта заказа. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.

Array of objects

Список цен в различных валютах.

Array

amount required	number <float> Сумма рекуррентного списания.
currency required	string Валюта заказа. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.
setup_fee	number <float> Дополнительная плата взимаемая единовременно в первом платеже.

object

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

ar	string Арабский.
bg	string Болгарский.
cn	string Китайский упрощенный.
cs	string Чешский.
de	string Немецкий.
en	string Английский.
es	string Испанский.
fr	string Французский.
he	string Иврит.
it	string Итальянский.
ja	string Японский.
ko	string Корейский.
pl	string Польский.
pt	string Португальский.
ro	string Румынский.
ru	string Русский.
th	string Тайский.
tr	string Турецкий.
tw	string Китайский традиционный.
vi	string Вьетнамский.

object

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

value required	integer Время до окончания срока подписки.
type required	string Единица времени. Может принимать значения `day`или `month`. Enum: "day" "month"

external_id

string

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

object

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

value required	integer Платежный цикл.
type required	string Единица времени. Может принимать значение `day`. Value: "day"

group_id

string

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

object

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

ar	string Арабский.
bg	string Болгарский.
cn	string Китайский упрощенный.
cs	string Чешский.
de	string Немецкий.
en	string Английский.
es	string Испанский.
fr	string Французский.
he	string Иврит.
it	string Итальянский.
ja	string Японский.
ko	string Корейский.
pl	string Польский.
pt	string Португальский.
ro	string Румынский.
ru	string Русский.
th	string Тайский.
tr	string Турецкий.
tw	string Китайский традиционный.
vi	string Вьетнамский.

refund_period

integer

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

object

value

string

Статус плана подписки.

Enum: "active" "disabled"

tags

Array of strings

Теги плана.

object

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

value required	integer Платежный цикл.
type required	string Единица времени. Может принимать значение `day`. Value: "day"

Responses

200

OK.

Request samples

application/json

{"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": null,
"trial": {"type": "day",
"value": 7
}
}

Response samples

application/json

{"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": 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"
}