Xsolla-logo

Actualizar plan

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

Actualiza los parámetros del plan de suscripción.

SecuritybasicAuth
Request
path Parameters
project_id
required
integer

ID de proyecto.

plan_id
required
integer

ID del plan.

Request Body schema: application/json
object

Detalles del reintento de facturación.

value
required
integer

Número de reintentos de facturación.

object

Datos de facturación.

required
object

Periodo de facturación.

value
required
integer

Número de unidades de tiempo. El valor depende del tipo de parámetro y puede ser:
- desde 1 hasta 366, si type es day
- desde 1 hasta 12, si type es month;
0 si type es lifetime

type
required
string

Unidades de tiempo. Puede ser day, month o lifetime.

Enum: "day" "month" "lifetime"
amount
number <float>

Importe de facturación.

currency
string

Moneda de la compra. Código de moneda de tres letras de conformidad con la norma ISO 4217.

Array of objects

Lista de precios en diferentes monedas.

Array
amount
required
number <float>

Importe de facturación.

currency
required
string

Moneda de la compra. Código de moneda de tres letras de conformidad con la norma ISO 4217.

setup_fee
number <float>

En la primera factura, se cobra una tarifa única de configuración.

object

Descripción del plan. El valor se compone de pares de "localization":"plan description".

ar
string

Árabe.

bg
string

Búlgaro.

cn
string

Chino (simplificado).

cs
string

Checo.

de
string

Alemán.

en
string

Inglés.

es
string

Español.

fr
string

Francés.

he
string

Hebreo.

it
string

Italiano.

ja
string

Japonés.

ko
string

Coreano.

pl
string

Polaco.

pt
string

Portugués.

ro
string

Rumano.

ru
string

Ruso.

th
string

Tailandés.

tr
string

Turco.

tw
string

Chino (tradicional).

vi
string

Vietnamita.

object

Datos de finalización de la suscripción.

value
required
integer

Periodo de validez.

type
required
string

Unidad de tiempo. Puede ser day o month.

Enum: "day" "month"
external_id
string

ID externo del plan (32 caracteres).

object

Detalles del periodo de gracia.

value
required
integer

Número de unidades de tiempo.

type
required
string

Unidad de tiempo. Puede ser day.

Value: "day"
group_id
string

ID del grupo al que está vinculado el plan.

object

Nombre del plan. El valor se compone de pares de "localization":"plan name".

ar
string

Árabe.

bg
string

Búlgaro.

cn
string

Chino (simplificado).

cs
string

Checo.

de
string

Alemán.

en
string

Inglés.

es
string

Español.

fr
string

Francés.

he
string

Hebreo.

it
string

Italiano.

ja
string

Japonés.

ko
string

Coreano.

pl
string

Polaco.

pt
string

Portugués.

ro
string

Rumano.

ru
string

Ruso.

th
string

Tailandés.

tr
string

Turco.

tw
string

Chino (tradicional).

vi
string

Vietnamita.

refund_period
integer

Periodo de tiempo durante el cual el usuario puede reembolsar el pago de un plan de suscripción (en días).

object
value
string

Estado del plan de suscripción.

Enum: "active" "disabled"
tags
Array of strings

Etiquetas del plan.

object

Detalles del periodo de prueba. Si no se transmite este parámetro, se emplean los valores por defecto (0 días).

value
required
integer

Número de unidades de tiempo.

type
required
string

Unidad de tiempo. Puede ser day.

Value: "day"
Responses
200

ACEPTAR.

Request samples
application/json
{
  • "billing_retry": {
    },
  • "charge": {
    },
  • "description": {
    },
  • "expiration": {
    },
  • "external_id": "exp",
  • "grace_period": {
    },
  • "name": {
    },
  • "refund_period": null,
  • "tags": null,
  • "trial": {
    }
}
Response samples
application/json
{
  • "billing_retry": {
    },
  • "charge": {
    },
  • "description": {
    },
  • "expiration": {
    },
  • "external_id": "exp",
  • "grace_period": {
    },
  • "group_id": null,
  • "id": 241082,
  • "localized_name": "Experience boost",
  • "name": {
    },
  • "project_id": 40797,
  • "refund_period": null,
  • "status": {
    },
  • "tags": [ ],
  • "trial": {
    },
  • "type": "all"
}