Saltar al contenido
/
Set promotion scope

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

Suscripciones

Operaciones

Pagos

Operaciones

Promociones

Operaciones

Get promotion scope

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
}

Set promotion scope

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

Toggle promotion

Solicitud

Alterna el estado de una promoción de enabled a disabled y viceversa.

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.

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

Respuestas

No content (Sin contenido).

Cupones

Operaciones

Suscripciones

Operaciones

Catalog

Operaciones

Cupones

Operaciones

Suscripciones

Operaciones

Payment accounts

Operaciones