Xsolla-logo

Atualizar AssinaturaServer-sideAdmin

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

Atualiza uma assinatura alterando seu status (active, canceled, ou non_renewing) ou atrasando a próxima data de cobrança.

SecuritybasicAuth
Request
path Parameters
project_id
required
integer

ID de projeto.

user_id
required
string

ID de usuário.

subscription_id
required
integer

ID de assinatura.

Request Body schema: application/json
cancel_subscription_payment
boolean

Definir como true reembolsará o último pagamento feito desta assinatura. Só funciona junto com a troca do status para canceled.

status
string

Status.

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

Adiamento de cobrança.

type
string

Unidade de tempo de cobrança. Pode ser day ou month.

Enum: "day" "month"
value
string

Quantidade de unidades de tempo a adiar da cobrança. O valor depende do parâmetro do tipo e pode ser:
- entre 1 e 366, se
for type type- entre 1 e 12, se day for month

user_id
string

ID de usuário.

object
collaborator_id
string

ID de colaborador — Identificador de Influenciador ou de rede de afiliados. Você pode encontrá-lo na seção Conta de Distribuidor > Rede de Parcerias > Influenciadores.

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