ID de vendedor.
Subscriptions API (2.0)
- 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/
Solicitud
Enumera todas las suscripciones recurrentes.
Aviso
Este método API no se puede utilizar con una carga elevada. La carga máxima es de 20 solicitudes por minuto.
Este método API no se puede utilizar con una carga elevada. La carga máxima es de 20 solicitudes por minuto.
Aviso
Esta llamada API no contiene el parámetro de ruta project_id, por lo que tiene que usar la clave de API que sea válida en todos los proyectos de la empresa para establecer la autorización.
Seguridad
basicAuth
- https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/subscriptions
- Mock serverhttps://xsolla.redocly.app/_mock/es/api/subscriptions/merchants/{merchant_id}/subscriptions
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/es/api/subscriptions/merchants/{merchant_id}/subscriptions?offset=0&limit=0&user_id=string&project_id%5B%5D=0&plan_id%5B%5D=0&product_id%5B%5D=0&group_id%5B%5D=string&status%5B%5D=active&datetime_from=string&datetime_to=string'ACEPTAR.
Moneda de la compra. Código de moneda de tres letras de conformidad con la norma ISO 4217.
Fecha de creación de la suscripción en formato "AAAA-MM-DD’T’HH:MM:SS" de conformidad con la norma ISO 8601.
Fecha de finalización de la suscripción en formato "AAAA-MM-DD’T’HH:MM:SS" de conformidad con la norma ISO 8601.
Fecha del último cobro de la suscripción en formato "AAAA-MM-DD’T’HH:MM:SS" de conformidad con la norma ISO 8601.
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.
Detalles del reintento de facturación.
Datos de facturación.
Moneda de la compra. Código de moneda de tres letras de conformidad con la norma ISO 4217.
Periodo de facturación.
Unidades de tiempo. Puede ser day, month o lifetime.
Enumeración"day""month""lifetime"
Lista de precios en diferentes monedas.
Moneda de la compra. Código de moneda de tres letras de conformidad con la norma ISO 4217.
Descripción del plan. El valor se compone de pares de "localization":"plan description".
Datos de finalización de la suscripción.
Detalles del periodo de gracia.
Nombre del plan. El valor se compone de pares de "localization":"plan name".
Periodo de tiempo durante el cual el usuario puede reembolsar el pago de un plan de suscripción (en días).
Descripciones de artículos localizadas.
Respuesta
application/json
[ { "charge_amount": 0.03, "currency": "USD", "date_create": "2013-09-05T15:27:47+04:00", "date_end": "2014-02-06T11:32:48+04:00", "date_last_charge": null, "date_next_charge": null, "id": 45, "plan": { … }, "product": { … }, "status": "canceled", "user": { … } } ]
- https://api.xsolla.com/merchant/v2/projects/{project_id}/subscriptions/{subscription_id}
- Mock serverhttps://xsolla.redocly.app/_mock/es/api/subscriptions/projects/{project_id}/subscriptions/{subscription_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/es/api/subscriptions/projects/{project_id}/subscriptions/{subscription_id}'ACEPTAR.
Moneda de la compra. Código de moneda de tres letras de conformidad con la norma ISO 4217.
Fecha de creación de la suscripción en formato "AAAA-MM-DD’T’HH:MM:SS" de conformidad con la norma ISO 8601.
Fecha de finalización de la suscripción en formato "AAAA-MM-DD’T’HH:MM:SS" de conformidad con la norma ISO 8601.
Fecha del último cobro de la suscripción en formato "AAAA-MM-DD’T’HH:MM:SS" de conformidad con la norma ISO 8601.
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.
Detalles del reintento de facturación.
Datos de facturación.
Moneda de la compra. Código de moneda de tres letras de conformidad con la norma ISO 4217.
Periodo de facturación.
Unidades de tiempo. Puede ser day, month o lifetime.
Enumeración"day""month""lifetime"
Lista de precios en diferentes monedas.
Moneda de la compra. Código de moneda de tres letras de conformidad con la norma ISO 4217.
Descripción del plan. El valor se compone de pares de "localization":"plan description".
Datos de finalización de la suscripción.
Detalles del periodo de gracia.
Nombre del plan. El valor se compone de pares de "localization":"plan name".
Periodo de tiempo durante el cual el usuario puede reembolsar el pago de un plan de suscripción (en días).
Descripciones de artículos localizadas.
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" } }
Cuerpoapplication/jsonrequerido
Al establecer true se reembolsará el último pago hecho para esta suscripción. Solo funciona si se establece el estado como canceled.
Aplazamiento de la facturación.
Unidad de tiempo de facturación. Puede ser day o month.
Enumeración"day""month"
ID de colaborador: identificador de 'influencer' o red de afiliados. Puedes encontrarlo en tu sección de Cuenta del editor > Red de socios > Influencers.
- https://api.xsolla.com/merchant/v2/projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}
- Mock serverhttps://xsolla.redocly.app/_mock/es/api/subscriptions/projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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"
}'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" } }