Saltar al contenido
/
Actualizar suscripción

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

Obtener suscripción

Solicitud

Obtiene detalles de una suscripción específica mediante un ID.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

ID de proyecto.

subscription_idintegerrequerido

ID de suscripción.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/projects/{project_id}/subscriptions/{subscription_id}'

Respuestas

ACEPTAR.

Cuerpoapplication/json
charge_amountnumber(float)

Importe de facturación.

commentstring

Motivo para cambiar el estado de la suscripción

currencystring

Moneda de la compra. Código de moneda de tres letras de conformidad con la norma ISO 4217.

date_createstring(datetime)

Fecha de creación de la suscripción en formato "AAAA-MM-DD’T’HH:MM:SS" de conformidad con la norma ISO 8601.

date_endstring(datetime)

Fecha de finalización de la suscripción en formato "AAAA-MM-DD’T’HH:MM:SS" de conformidad con la norma ISO 8601.

date_last_chargestring or null(datetime)

Fecha del último cobro de la suscripción en formato "AAAA-MM-DD’T’HH:MM:SS" de conformidad con la norma ISO 8601.

date_next_chargestring or null(datetime)

Fecha del próximo cobro de la suscripción en formato "AAAA-MM-DD’T’HH:MM:SS" de conformidad con la norma ISO 8601.

idinteger

ID de suscripción

planobject
productobject or null
statusstring

Estado

Enumeración"new""active""canceled""non_renewing""freeze"
userobject
Respuesta
application/json
{
  "charge_amount": 0.03,
  "comment": "The subscription was not extended in due time",
  "currency": "USD",
  "date_create": "2018-09-21T16:54:59+03:00",
  "date_end": "2019-02-06T12:43:04+03:00",
  "date_last_charge": "2018-09-21T16:55:05+03:00",
  "date_next_charge": "2018-09-21T16:55:05+03:00",
  "id": 249579,
  "plan": {
    "external_id": "lowcost",
    "id": 601
  },
  "product": {
    "id": 123456
  },
  "status": "canceled",
  "user": {
    "id": "user1",
    "name": "John Smith"
  }
}

Actualizar suscripción

Solicitud

Actualiza una suscripción al cambiar su estado (active, canceled o non_renewing) o al aplazar la próxima fecha de facturación.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

ID de proyecto.

user_idstringrequerido

ID de usuario.

subscription_idintegerrequerido

ID de suscripción.

Cuerpoapplication/jsonrequerido
cancel_subscription_paymentboolean

Al establecer true se reembolsará el último pago hecho para esta suscripción. Solo funciona si se establece el estado como canceled.

statusstring

Estado.

Enumeración"active""canceled""non_renewing"
timeshiftobject

Aplazamiento de la facturación.

xsolla_networkobject
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "active"
  }'

Respuestas

ACEPTAR.

Cuerpoapplication/json
Respuesta
application/json
{
  "charge_amount": 0.03,
  "currency": "USD",
  "date_create": "2018-09-21T16:54:59+03:00",
  "date_end": null,
  "date_last_charge": "2018-09-21T16:55:05+03:00",
  "date_next_charge": "2018-09-21T16:55:05+03:00",
  "id": 24953579,
  "plan": {
    "billing_retry": { … },
    "charge": { … },
    "description": null,
    "expiration": { … },
    "external_id": "lowcost",
    "grace_period": { … },
    "group_id": "newPlans",
    "id": 66001,
    "localized_name": null,
    "name": null,
    "project_id": 18404,
    "refund_period": null,
    "status": { … },
    "tags": null,
    "trial": { … },
    "type": "all"
  },
  "product": null,
  "status": "active",
  "user": {
    "id": "jb1",
    "name": "J.Black"
  }
}

Pagos

Operaciones

Promociones

Operaciones

Cupones

Operaciones

Subscription management

Operaciones