Saltar al contenido

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
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/es/api/subscriptions/
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones

Solicitud

Seguridad
projectUserJwtAuth
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/projects/{project_id}/subscriptions/{subscription_id}?locale=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respuestas

Get subscription info

Cuerpoapplication/json
chargeobjectrequerido
charge.​amountnumber(float)requerido
Ejemplo: 4.99
charge.​currencystringrequerido
Ejemplo: "USD"
charge.​setup_feenumber(float)requerido
Ejemplo: 0.99
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"
periodobjectrequerido
period.​unitstring or null
Predeterminado null
Ejemplo: "month"
period.​valueinteger or null
Predeterminado null
Ejemplo: "1"
plan_descriptionstringrequerido
Ejemplo: "Localized plan description"
plan_end_datestring or null(date-time)
Ejemplo: "2031-04-11T13:51:02+03:00"
plan_external_idstringrequerido
Ejemplo: "PlanExternalId"
plan_idintegerrequerido
Ejemplo: "54321"
plan_namestringrequerido
Ejemplo: "Localized plan name"
plan_start_datestring or null(date-time)
Ejemplo: "2021-04-11T13:51:02+03:00"
product_descriptionstring or null
Ejemplo: "Localized product description"
product_external_idstring or null
Ejemplo: "ProductExternalId"
product_idinteger or null
Ejemplo: "12345"
product_namestring or null
Ejemplo: "Product name"
statusstringrequerido
Ejemplo: "active"
trial_periodinteger or null
Ejemplo: "0"
Respuesta
application/json
{ "charge": { "amount": 4.99, "currency": "USD", "setup_fee": 0.99 }, "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", "period": { "unit": "month", "value": "1" }, "plan_description": "Localized plan description", "plan_end_date": "2031-04-11T13:51:02+03:00", "plan_external_id": "PlanExternalId", "plan_id": "54321", "plan_name": "Localized plan name", "plan_start_date": "2021-04-11T13:51:02+03:00", "product_description": "Localized product description", "product_external_id": "ProductExternalId", "product_id": "12345", "product_name": "Product name", "status": "active", "trial_period": "0" }

Solicitud

Seguridad
projectUserJwtAuth
Ruta
subscription_idinteger\d+requerido
project_idinteger\d+requerido
curl -i -X PUT \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/api/user/v1/projects/{project_id}/subscriptions/{subscription_id}/cancel' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respuestas

Make subscription non-renewable

Cuerpoapplication/json
Respuesta
application/json
null
Operaciones
Operaciones
Operaciones
Operaciones