Saltar al contenido
/
List plans by product (no...

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

Cupones

Operaciones

Suscripciones

Operaciones

Catalog

Operaciones

List products (no auth)

Solicitud

Ruta
project_idinteger\d+requerido
Consulta
limitinteger
offsetinteger
localestring
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/api/public/v1/projects/{project_id}/products?limit=0&offset=0&locale=string'

Respuestas

Subscription's products

Cuerpoapplication/json
has_morebooleanrequerido
Ejemplo: false
itemsArray of objects
Predeterminado []
items[].​product_descriptionstring or null
Ejemplo: "Localized product description"
items[].​product_external_idstring or null
Ejemplo: "ProductExternalId"
items[].​product_group_idstring or null
Ejemplo: "TestGroupId"
items[].​product_idintegerrequerido
Ejemplo: "12345"
items[].​product_namestringrequerido
Ejemplo: "Product name"
Respuesta
application/json
{
  "has_more": false,
  "items": []
}

List plans by product (no auth)

Solicitud

Ruta
project_idinteger\d+requerido
productIdstringrequerido
Consulta
plan_idArray of integers
plan_external_idArray of strings
limitinteger
offsetinteger
localestring
countrystring
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/api/public/v1/projects/{project_id}/products/{productId}/user_plans?plan_id=0&plan_external_id=string&limit=0&offset=0&locale=string&country=string'

Respuestas

Subscription's plans by product

Cuerpoapplication/json
has_morebooleanrequerido
Ejemplo: "false"
itemsArray of objects
Predeterminado []
items[].​chargeobjectrequerido
items[].​charge.​amountnumber(float)requerido
Ejemplo: 4.99
items[].​charge.​currencystringrequerido
Ejemplo: "USD"
items[].​charge.​setup_feenumber(float)requerido
Ejemplo: 0.99
items[].​periodobjectrequerido
items[].​period.​unitstring or null
Predeterminado null
Ejemplo: "month"
items[].​period.​valueinteger or null
Predeterminado null
Ejemplo: "1"
items[].​plan_descriptionstringrequerido
Ejemplo: "Localized plan description"
items[].​plan_end_datestring or null(date-time)
Ejemplo: "2031-04-11T13:51:02+03:00"
items[].​plan_external_idstringrequerido
Ejemplo: "PlanExternalId"
items[].​plan_group_idstring or null
Ejemplo: "TestGroupId"
items[].​plan_idintegerrequerido
Ejemplo: "54321"
items[].​plan_namestringrequerido
Ejemplo: "Localized plan name"
items[].​plan_start_datestring or null(date-time)
Ejemplo: "2021-04-11T13:51:02+03:00"
items[].​plan_typestringrequerido
Ejemplo: "all"
items[].​promotionobjectrequerido
items[].​promotion.​promotion_charge_amountnumber or null(float)
Predeterminado null
Ejemplo: "3.99"
items[].​promotion.​promotion_remaining_chargesinteger or null
Predeterminado null
Ejemplo: "3"
items[].​trial_periodinteger or null
Ejemplo: "7"
Respuesta
application/json
{
  "has_more": "false",
  "items": []
}

List plans (no auth)

Solicitud

Ruta
project_idinteger\d+requerido
Consulta
plan_idArray of integers
plan_external_idArray of strings
limitinteger
offsetinteger
localestring
countrystring
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/api/public/v1/projects/{project_id}/user_plans?plan_id=0&plan_external_id=string&limit=0&offset=0&locale=string&country=string'

Respuestas

Subscription's default plans

Cuerpoapplication/json
has_morebooleanrequerido
Ejemplo: "false"
itemsArray of objects
Predeterminado []
items[].​chargeobjectrequerido
items[].​charge.​amountnumber(float)requerido
Ejemplo: 4.99
items[].​charge.​currencystringrequerido
Ejemplo: "USD"
items[].​charge.​setup_feenumber(float)requerido
Ejemplo: 0.99
items[].​periodobjectrequerido
items[].​period.​unitstring or null
Predeterminado null
Ejemplo: "month"
items[].​period.​valueinteger or null
Predeterminado null
Ejemplo: "1"
items[].​plan_descriptionstringrequerido
Ejemplo: "Localized plan description"
items[].​plan_end_datestring or null(date-time)
Ejemplo: "2031-04-11T13:51:02+03:00"
items[].​plan_external_idstringrequerido
Ejemplo: "PlanExternalId"
items[].​plan_group_idstring or null
Ejemplo: "TestGroupId"
items[].​plan_idintegerrequerido
Ejemplo: "54321"
items[].​plan_namestringrequerido
Ejemplo: "Localized plan name"
items[].​plan_start_datestring or null(date-time)
Ejemplo: "2021-04-11T13:51:02+03:00"
items[].​plan_typestringrequerido
Ejemplo: "all"
items[].​promotionobjectrequerido
items[].​promotion.​promotion_charge_amountnumber or null(float)
Predeterminado null
Ejemplo: "3.99"
items[].​promotion.​promotion_remaining_chargesinteger or null
Predeterminado null
Ejemplo: "3"
items[].​trial_periodinteger or null
Ejemplo: "7"
Respuesta
application/json
{
  "has_more": "false",
  "items": []
}

Cupones

Operaciones

Suscripciones

Operaciones

Payment accounts

Operaciones