Saltar al contenido
/
Canjear cupón

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

Cupones

Operaciones

Obtener cupón

Solicitud

Obtén los detalles del cupón mediante su código.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

ID de proyecto.

codestringrequerido

Código de cupón.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/projects/{project_id}/coupons/{code}/details'

Respuestas

ACEPTAR.

Cuerpoapplication/json
keystring

Clave del atributo de usuario.

list_of_valuesArray of objects

Matriz de valores posibles para el tipo enum.

nameobject

Nombres de atributos localizados.

skip_condition_on_nonexistent_keyboolean

Si se omite la condición si la clave no existe.

typestring

Tipo de clave.

Enumeración"int""string""enum""date"
visibleboolean
Respuesta
application/json
{
  "key": "12",
  "list_of_values": [],
  "name": {
    "en": "Level",
    "ru": "Уровень"
  },
  "skip_condition_on_nonexistent_key": true,
  "type": "int",
  "visible": false
}

Canjear cupón

Solicitud

Canjear un cupón mediante su código.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

ID de proyecto.

codestringrequerido

Código de cupón.

Cuerpoapplication/jsonrequerido
user_idstringrequerido

ID de usuario.

Ejemplo: "1234"
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/projects/{project_id}/coupons/{code}/redeem' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_id": "1234"
  }'

Respuestas

ACEPTAR.

Cuerpoapplication/json
campaign_codestring
coupon_codestring
coupon_idinteger
expiration_datestring
is_activeboolean
project_idinteger
redeems_count_for_userinteger
redeems_count_remaininteger
subscription_couponstring or null
virtual_currency_amountinteger
virtual_itemsArray of strings
Respuesta
application/json
{
  "campaign_code": "new_campaign",
  "coupon_code": "ddgf5bn4",
  "coupon_id": 89613996,
  "expiration_date": "2019-12-31T00:00:00+00:00",
  "is_active": true,
  "project_id": 12345,
  "redeems_count_for_user": 10,
  "redeems_count_remain": 20,
  "subscription_coupon": null,
  "virtual_currency_amount": 200,
  "virtual_items": []
}

Subscription management

Operaciones