Saltar al contenido
/
Get management settings

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 subscriptions

Solicitud

Seguridad
subscriptionsManagementJwtAuth
Ruta
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?limit=0&offset=0&locale=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respuestas

Get subscriptions info

Cuerpoapplication/json
has_morebooleanrequerido
Ejemplo: "false"
itemsArray of objects(ManagementSubscriptionResponse2)
Predeterminado []
Respuesta
application/json
{
  "has_more": "false",
  "items": []
}

Get management settings

Solicitud

Seguridad
subscriptionsManagementJwtAuth
Ruta
project_idinteger\d+requerido
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/api/user/v1/management/projects/{project_id}/subscriptions/settings' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respuestas

Returns project settings for managing subscription

Cuerpoapplication/json
allow_change_packagebooleanrequerido
Ejemplo: "true"
recurrent_cancel_possiblebooleanrequerido
Ejemplo: "true"
Respuesta
application/json
{
  "allow_change_package": "true",
  "recurrent_cancel_possible": "true"
}

Get subscription

Solicitud

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

Respuestas

Get subscription info

Cuerpoapplication/json
chargeobject(Charge)requerido
charge.​amountnumber(float)requerido
Ejemplo: "4.99"
charge.​amount_with_promotionnumber or null(float)
Predeterminado null
Ejemplo: "3.99"
charge.​currencystringrequerido
Ejemplo: "USD"
date_createstring(date-time)requerido
Ejemplo: "2031-04-11T13:51:02+03:00"
date_endstring or null(date-time)
Ejemplo: "2031-04-11T13:51:02+03:00"
date_last_chargestring or null(date-time)
Ejemplo: "2031-04-11T13:51:02+03:00"
date_next_chargestring or null(date-time)
Ejemplo: "2031-04-11T13:51:02+03:00"
idintegerrequerido
Ejemplo: "12345"
is_change_plan_allowedbooleanrequerido
Ejemplo: "false"
is_change_to_non_renew_possiblebooleanrequerido
Ejemplo: "true"
is_in_trialbooleanrequerido
Ejemplo: "false"
is_renew_possiblebooleanrequerido
Ejemplo: "true"
last_successful_charge(LastSuccessfulCharge (object or null))
(LastSuccessfulCharge (object or null))
payment_account(PaymentRecurrentAccountResponse2 (object or null))
(PaymentRecurrentAccountResponse2 (object or null))
periodobject(Period)requerido
period.​unitstring or null
Predeterminado null
Ejemplo: "month"
period.​valueinteger or null
Predeterminado null
Ejemplo: "1"
plan_descriptionstringrequerido
Ejemplo: "Localized plan description"
plan_namestringrequerido
Ejemplo: "Localized plan name"
product_descriptionstring or null
Ejemplo: "Localized product description"
product_namestring or null
Ejemplo: "Product name"
statusstringrequerido
Ejemplo: "active"
trial_periodinteger or null
Ejemplo: "0"
Respuesta
application/json
{
  "charge": {
    "amount": "4.99",
    "amount_with_promotion": "3.99",
    "currency": "USD"
  },
  "date_create": "2031-04-11T13:51:02+03:00",
  "date_end": "2031-04-11T13:51:02+03:00",
  "date_last_charge": "2031-04-11T13:51:02+03:00",
  "date_next_charge": "2031-04-11T13:51:02+03:00",
  "id": "12345",
  "is_change_plan_allowed": "false",
  "is_change_to_non_renew_possible": "true",
  "is_in_trial": "false",
  "is_renew_possible": "true",
  "last_successful_charge": {
    "amount": "3.99",
    "currency": "USD",
    "date": "2031-04-11T13:51:02+03:00"
  },
  "payment_account": {
    "card_expiry_date": { … },
    "id": "123",
    "name": "** 7398",
    "ps_name": "Mastercard",
    "switch_icon_name": "mastercard.svg",
    "type": "card"
  },
  "period": {
    "unit": "month",
    "value": "1"
  },
  "plan_description": "Localized plan description",
  "plan_name": "Localized plan name",
  "product_description": "Localized product description",
  "product_name": "Product name",
  "status": "active",
  "trial_period": "0"
}