Saltar al contenido
/
Unlink payment account

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

Subscription management

Operaciones

List plans for change

Solicitud

Seguridad
subscriptionsManagementJwtAuth
Ruta
subscription_idinteger\d+requerido
project_idinteger\d+requerido
Consulta
limitinteger
offsetinteger
localestring
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/plans_for_change?limit=0&offset=0&locale=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respuestas

List of available plans for change

Cuerpoapplication/json
has_morebooleanrequerido
Ejemplo: "false"
itemsArray of objects(PlanResponse)
Predeterminado []
items[].​chargeobject(Charge4)requerido
items[].​charge.​amountnumber(float)requerido
Ejemplo: "4.99"
items[].​charge.​currencystringrequerido
Ejemplo: "USD"
items[].​charge.​setup_feenumber or null(float)
Ejemplo: "0.99"
items[].​periodobject(Period4)requerido
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[].​promotionobject(Promotion2)requerido
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": []
}