Xsolla-logo

Изменение подпискиServer-sideAdmin

put/projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}

Изменение рекуррентной подписки. Можно изменить статус подписки (active, canceled или non_renewing) и отложить дату следующего списания для данной подписки.

SecuritybasicAuth
Request
path Parameters
project_id
required
integer

ID проекта.

user_id
required
string

ID пользователя.

subscription_id
required
integer

ID подписки.

Request Body schema: application/json
cancel_subscription_payment
boolean

Если передано значение true, то происходит отмена последнего платежа, сделанного по подписке. Данный параметр работает, только если статус платежа изменен на canceled.

status
string

Статус.

Enum: "active" "canceled" "non_renewing"
object

Объект с информацией об отложенном сроке следующего списания.

type
string

Период платежного цикла, принимает значения day или month.

Enum: "day" "month"
value
string

Время, на которое нужно перенести выставление счета. Значение зависит от типа параметра и может быть:
- от 1 до 366, если параметр type принимает значение day
- от 1 до 12, если параметр type принимает значение month

user_id
string

ID пользователя.

object
collaborator_id
string

ID партнера — идентификатор инфлюенсера или аффилированной сети. Можно найти в Личном кабинете в разделе Partner Network > Инфлюенсеры.

Responses
200

OK.

Request samples
application/json
{
  • "status": "active"
}
Response samples
application/json
{
  • "charge_amount": 0.03,
  • "currency": "USD",
  • "date_create": "2018-09-21T16:54:59+0300",
  • "date_end": null,
  • "date_last_charge": "2018-09-21T16:55:05+0300",
  • "date_next_charge": "2018-09-21T16:55:05+0300",
  • "id": 24953579,
  • "plan": {
    },
  • "product": null,
  • "status": "active",
  • "user": {
    }
}