Saltar al contenido
/
List plans for change

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 []
Respuesta
application/json
{
  "has_more": "false",
  "items": []
}

Get plan for change

Solicitud

Seguridad
subscriptionsManagementJwtAuth
Ruta
subscription_idinteger\d+requerido
plan_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}/plans_for_change/{plan_id}?locale=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respuestas

Available plans for change with payment details

Cuerpoapplication/json
chargeobject(Charge2)requerido
charge.​amountnumber(float)requerido
Ejemplo: "4.99"
charge.​currencystringrequerido
Ejemplo: "USD"
charge.​setup_feenumber or null(float)
Ejemplo: "0.99"
payment_detailsobject(PaymentDetails)requerido
payment_details.​surcharge(Surcharge (object or null))
Predeterminado null
(Surcharge (object or null))
Predeterminado null
payment_details.​unused(Unused (object or null))
Predeterminado null
(Unused (object or null))
Predeterminado null
periodobject(Period2)requerido
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_group_idstring or null
Ejemplo: "TestGroupId"
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"
plan_typestringrequerido
Ejemplo: "all"
promotionobject(Promotion)requerido
promotion.​promotion_charge_amountnumber or null(float)
Predeterminado null
Ejemplo: "3.99"
promotion.​promotion_remaining_chargesinteger or null
Predeterminado null
Ejemplo: "3"
trial_periodinteger or null
Ejemplo: "7"
Respuesta
application/json
{
  "charge": {
    "amount": "4.99",
    "currency": "USD",
    "setup_fee": "0.99"
  },
  "payment_details": {
    "surcharge": null,
    "unused": null
  },
  "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_group_id": "TestGroupId",
  "plan_id": "54321",
  "plan_name": "Localized plan name",
  "plan_start_date": "2021-04-11T13:51:02+03:00",
  "plan_type": "all",
  "promotion": {
    "promotion_charge_amount": "3.99",
    "promotion_remaining_charges": "3"
  },
  "trial_period": "7"
}