Saltar al contenido
/
Obtener planes

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

Obtener planes

Solicitud

Muestra todos los planes de suscripción.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

ID de proyecto.

Consulta
plan_idinteger

ID del plan de suscripción.

limitintegerrequerido

Límite para el número de elementos presentes en la página.

offsetinteger

Número del elemento a partir del cual se genera la lista (el conteo empieza desde el 0).

external_idstring

ID externo del plan (32 caracteres).

group_idstring

ID del grupo a los que están vinculados los planes.

product_idinteger

ID del producto al que está vinculado el plan.

querystring

Consulta de búsqueda (busca name.en (configuración regional predeterminada)).

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/projects/{project_id}/subscriptions/plans?plan_id=0&limit=0&offset=0&external_id=string&group_id=string&product_id=0&query=string'

Respuestas

ACEPTAR.

Cuerpoapplication/jsonArray [
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 or null

ID del grupo al que está vinculado el plan.

idinteger

ID del plan de suscripción.

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.

project_idinteger

ID de proyecto.

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.

trial.​typestringrequerido

Unidad de tiempo. Puede ser day.

Valor"day"
trial.​valueintegerrequerido

Número de unidades de tiempo.

localized_namestring

Nombre del plan en el idioma por defecto (EN), replica el valor de name.en.

]
Respuesta
application/json
[
  {
    "billing_retry": { … },
    "charge": { … },
    "description": { … },
    "expiration": { … },
    "external_id": "3b355320",
    "grace_period": { … },
    "group_id": null,
    "id": 241037,
    "localized_name": "Platinum VIP",
    "name": { … },
    "project_id": 40797,
    "refund_period": null,
    "status": { … },
    "tags": [],
    "trial": { … }
  },
  {
    "billing_retry": { … },
    "charge": { … },
    "description": { … },
    "expiration": { … },
    "external_id": "0fe1b6fc",
    "grace_period": { … },
    "group_id": null,
    "id": 241038,
    "localized_name": "Gold Status",
    "name": { … },
    "project_id": 40797,
    "refund_period": null,
    "status": { … },
    "tags": [],
    "trial": { … }
  }
]

Crear plan

Solicitud

Crea un plan de suscripción.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

ID de proyecto.

Cuerpoapplication/jsonrequerido
billing_retryobject

Detalles del reintento de facturación.

billing_retry.​valueintegerrequerido

Número de reintentos de facturación.

chargeobjectrequerido

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 or null

ID del grupo al que está vinculado el plan.

idinteger

ID del plan de suscripción.

nameobjectrequerido

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.

project_idinteger

ID de proyecto.

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.

trial.​typestringrequerido

Unidad de tiempo. Puede ser day.

Valor"day"
trial.​valueintegerrequerido

Número de unidades de tiempo.

curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/projects/{project_id}/subscriptions/plans' \
  -H 'Content-Type: application/json' \
  -d '{
    "billing_retry": {
      "value": 1
    },
    "charge": {
      "amount": 10,
      "currency": "USD",
      "period": {
        "type": "month",
        "value": 1
      },
      "prices": [
        {
          "amount": 8,
          "currency": "EUR",
          "setup_fee": 1.5
        },
        {
          "amount": 1000,
          "currency": "JPY",
          "setup_fee": 2.5
        }
      ]
    },
    "description": {
      "en": "2x more experience!"
    },
    "expiration": {
      "type": "day",
      "value": null
    },
    "external_id": "exp",
    "grace_period": {
      "type": "day",
      "value": 2
    },
    "name": {
      "en": "Experience boost"
    },
    "refund_period": null,
    "status": {
      "value": "active"
    },
    "trial": {
      "type": "day",
      "value": 7
    }
  }'

Respuestas

Creado.

Cuerpoapplication/json
external_idstring
plan_idinteger
Respuesta
application/json
{
  "external_id": "exp",
  "plan_id": 241082
}

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).

Productos

Operaciones

Subscription management

Operaciones

Pagos

Operaciones

Promociones

Operaciones

Cupones

Operaciones

Subscription management

Operaciones