Saltar al contenido
/
Obtener asunto

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

Productos

Operaciones

Subscription management

Operaciones

Pagos

Operaciones

Promociones

Operaciones

Establecer recompensas

Solicitud

Establece las recompensas de una promoción. Si la promoción es de solo lectura (read_only = true), no puedes actualizar las recompensas.

Aviso

Esta llamada API no contiene el parámetro de ruta project_id, por lo que tiene que usar la clave de API que sea válida en todos los proyectos de la empresa para establecer la autorización.

Seguridad
basicAuth
Ruta
merchant_idintegerrequerido

ID de vendedor.

promotion_idintegerrequerido

ID de promoción.

Cuerpoapplication/jsonrequerido
itemobject

Establecer la recompensa por artículos virtuales específicos.

item.​bonusArray of objects

Artículos virtuales adicionales como bonificación.

item.​bonus[].​idinteger
item.​bonus[].​localized_namestring

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

item.​bonus[].​quantityinteger

Número de artículos virtuales ofrecidos como bonificación.

item.​bonus[].​skustring

Código (SKU) del artículo.

item.​discountArray of objects

Descuentos para artículos virtuales específicos.

item.​discount[].​discount_percentnumber(float)

Porcentaje de descuento.

item.​discount[].​localized_namestring

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

item.​discount[].​max_amountnumber(integer)

Número máximo de artículos a los que se puede aplicar la promoción.

item.​discount[].​skustring

Código (SKU) del artículo.

packageobject

Establecer la recompensa por un paquete de moneda virtual.

package.​bonus_amountnumber(float)

Recompensa como una cantidad absoluta de moneda virtual.

package.​bonus_percentnumber(float)

Recompensa como un porcentaje del importe del paquete.

purchaseobject

Establecer la recompensa por la totalidad de la compra.

purchase.​discount_percentnumber(float)

Porcentaje de descuento.

subscriptionobject

Establece la recompensa por una suscripción.

subscription.​trial_daysinteger

Periodo de prueba en días.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/rewards' \
  -H 'Content-Type: application/json' \
  -d '{
    "item": {
      "bonus": [
        {
          "quantity": 2,
          "sku": "1234"
        }
      ],
      "discount": [
        {
          "discount_percent": 5,
          "max_amount": 10,
          "sku": "1234"
        }
      ]
    },
    "package": {
      "bonus_amount": 5,
      "bonus_percent": 5
    },
    "purchase": {
      "discount_percent": 10
    },
    "subscription": {
      "trial_days": 30
    }
  }'

Respuestas

No content (Sin contenido).

Obtener asunto

Solicitud

Obtiene información sobre el tema de una promoción.

Aviso

Esta llamada API no contiene el parámetro de rutaproject_id, por lo que tiene que usar la clave de API que sea válida en todos los proyectos de la empresa para establecer la autorización.

Seguridad
basicAuth
Ruta
merchant_idintegerrequerido

ID de vendedor.

promotion_idintegerrequerido

ID de promoción.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/subject'

Respuestas

ACEPTAR.

Cuerpoapplication/json
digital_contentsobject or null
itemsArray of objects

Conjunto de artículos virtuales a los que se aplica la promoción.

items[].​idinteger
items[].​localized_namestring

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

items[].​skustring

Código (SKU) del artículo.

packagesArray of objects or null

Conjunto de paquetes de moneda virtual a los que se aplica la promoción.

purchaseboolean

Si la promoción se aplica o no a la totalidad de la compra.

subscriptionsobject or null

Planes de suscripción o productos a los que se aplica la promoción.

subscriptions.​max_charges_countinteger

Número máximo de facturas a las que se aplica la promoción.

subscriptions.​plansArray of strings
subscriptions.​productsArray of strings
idinteger
Respuesta
application/json
{
  "digital_contents": null,
  "id": 178,
  "items": [
    { … }
  ],
  "packages": null,
  "purchase": false,
  "subscriptions": null
}

Establecer asunto

Solicitud

Establece el asunto de una promoción. Si la promoción es de solo lectura (read_only = true), no se puede actualizar el asunto. El asunto puede tomar los siguientes valores: purchase, o items, o packages.

Aviso

Esta llamada API no contiene el parámetro de ruta project_id, por lo que tiene que usar la clave de API que sea válida en todos los proyectos de la empresa para establecer la autorización.

Seguridad
basicAuth
Ruta
merchant_idintegerrequerido

ID de vendedor.

promotion_idintegerrequerido

ID de promoción.

Cuerpoapplication/jsonrequerido
digital_contentsobject or null
itemsArray of objects

Conjunto de artículos virtuales a los que se aplica la promoción.

items[].​idinteger
items[].​localized_namestring

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

items[].​skustring

Código (SKU) del artículo.

packagesArray of objects or null

Conjunto de paquetes de moneda virtual a los que se aplica la promoción.

purchaseboolean

Si la promoción se aplica o no a la totalidad de la compra.

subscriptionsobject or null

Planes de suscripción o productos a los que se aplica la promoción.

subscriptions.​max_charges_countinteger

Número máximo de facturas a las que se aplica la promoción.

subscriptions.​plansArray of strings
subscriptions.​productsArray of strings
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/subject' \
  -H 'Content-Type: application/json' \
  -d '{
    "digital_contents": null,
    "items": [
      {
        "sku": "1234"
      }
    ],
    "packages": null,
    "purchase": false,
    "subscriptions": null
  }'

Respuestas

No content (Sin contenido).

Cupones

Operaciones

Subscription management

Operaciones