Saltar al contenido
/
Activar plan

Subscriptions API (2.0)

Información general

  • Versión: 2.0
  • Servidores: https://api.xsolla.com/merchant/v2/

Esta referencia de API describe los extremos para administrar suscripciones, cupones y promociones. Para obtener más información sobre las suscripciones, consulta la página guía del producto y el glosario.

Descargar descripción de OpenAPI
index.json
index.yaml
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/es/api/subscriptions/

Token

Operaciones

Planes

Operaciones

Desactivar plan

Solicitud

Desactiva un plan de suscripción.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

ID de proyecto.

plan_idintegerrequerido

ID del plan.

curl -i -X DELETE \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/projects/{project_id}/subscriptions/plans/{plan_id}'

Respuestas

No content (Sin contenido).

Activar plan

Solicitud

Activa un plan de suscripción.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

ID de proyecto.

plan_idintegerrequerido

ID del plan.

curl -i -X PATCH \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/projects/{project_id}/subscriptions/plans/{plan_id}'

Respuestas

No content (Sin contenido).

Actualizar plan

Solicitud

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

Seguridad
basicAuth
Ruta
project_idintegerrequerido

ID de proyecto.

plan_idintegerrequerido

ID del plan.

Cuerpoapplication/jsonrequerido
billing_retryobject

Detalles del reintento de facturación.

billing_retry.​valueintegerrequerido

Número de reintentos de facturación.

chargeobject

Datos de facturación.

charge.​amountnumber(float)

Importe de facturación.

charge.​currencystring

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

charge.​periodobjectrequerido

Periodo de facturación.

charge.​period.​typestringrequerido

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

Enumeración"day""month""lifetime"
charge.​period.​valueintegerrequerido

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

charge.​pricesArray of objects

Lista de precios en diferentes monedas.

charge.​prices[].​amountnumber(float)requerido

Importe de facturación.

charge.​prices[].​currencystringrequerido

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

charge.​prices[].​setup_feenumber(float)

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

descriptionobject

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

description.​arstring

Árabe.

description.​bgstring

Búlgaro.

description.​cnstring

Chino (simplificado).

description.​csstring

Checo.

description.​destring

Alemán.

description.​enstring

Inglés.

description.​esstring

Español.

description.​frstring

Francés.

description.​hestring

Hebreo.

description.​itstring

Italiano.

description.​jastring

Japonés.

description.​kostring

Coreano.

description.​plstring

Polaco.

description.​ptstring

Portugués.

description.​rostring

Rumano.

description.​rustring

Ruso.

description.​thstring

Tailandés.

description.​trstring

Turco.

description.​twstring

Chino (tradicional).

description.​vistring

Vietnamita.

expirationobject

Datos de finalización de la suscripción.

expiration.​typestringrequerido

Unidad de tiempo. Puede ser day o month.

Enumeración"day""month"
expiration.​valueinteger or nullrequerido

Periodo de validez.

external_idstring

ID externo del plan (32 caracteres).

grace_periodobject

Detalles del periodo de gracia.

grace_period.​typestringrequerido

Unidad de tiempo. Puede ser day.

Valor"day"
grace_period.​valueintegerrequerido

Número de unidades de tiempo.

group_idstring

ID del grupo al que está vinculado el plan.

nameobject

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

name.​arstring

Árabe.

name.​bgstring

Búlgaro.

name.​cnstring

Chino (simplificado).

name.​csstring

Checo.

name.​destring

Alemán.

name.​enstring

Inglés.

name.​esstring

Español.

name.​frstring

Francés.

name.​hestring

Hebreo.

name.​itstring

Italiano.

name.​jastring

Japonés.

name.​kostring

Coreano.

name.​plstring

Polaco.

name.​ptstring

Portugués.

name.​rostring

Rumano.

name.​rustring

Ruso.

name.​thstring

Tailandés.

name.​trstring

Turco.

name.​twstring

Chino (tradicional).

name.​vistring

Vietnamita.

refund_periodinteger or null

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

statusobject
status.​valuestring

Estado del plan de suscripción.

Enumeración"active""disabled"
tagsArray of strings

Etiquetas del plan.

trialobject

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

trial.​typestringrequerido

Unidad de tiempo. Puede ser day.

Valor"day"
trial.​valueintegerrequerido

Número de unidades de tiempo.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/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
    }
  }'

Respuestas

ACEPTAR.

Cuerpoapplication/json
Respuesta
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"
}

Productos

Operaciones

Subscription management

Operaciones

Pagos

Operaciones

Promociones

Operaciones

Cupones

Operaciones

Subscription management

Operaciones