# Subscriptions API # 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](https://developers.xsolla.com/es/doc/subscriptions) y el [glosario](https://developers.xsolla.com/es/doc/subscriptions/integration-guide/get-started/#general_glossary). Version: 2.0 ## Security ### basicAuth La API de Xsolla emplea autenticación básica de acceso. Todas las solicitudes a la API deben contener el encabezado `Authorization: Basic `, en el cual `` es el par `merchant_id:api_key` codificado según el estándar Base64. Accede a [Cuenta del editor](https://publisher.xsolla.com/) para encontrar estos parámetros:
Para obtener más información sobre cómo trabajar con claves de API, consulta la [Referencia de la API](https://developers.xsolla.com/es/api/getting-started/#api_keys_overview). Type: http Scheme: basic ### subscriptionsManagementJwtAuth Type: http Scheme: bearer ## Download OpenAPI description [Subscriptions API](https://developers.xsolla.com/_bundle/@l10n/es/api/subscriptions/index.yaml) ## Token ### Crear token - [POST /merchants/{merchant_id}/token](https://developers.xsolla.com/es/api/subscriptions/token/create-token.md): Puede crear un token con parámetros de usuario arbitrarios. Envíe estos parámetros al obtener el token y recíbalos después de un pago exitoso. Un token solo puede contener parámetros descritos en este documento o predefinidos por usted. Si algún parámetro se envía en el formato incorrecto o tiene el tipo incorrecto, no se emitirá ningún token. Recibirá un código HTTP 422 con la descripción del error en el cuerpo JSON. En extended_message recibirá información sobre qué parámetros exactos se enviaron incorrectamente. 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. ## Planes ### Obtener planes - [GET /projects/{project_id}/subscriptions/plans](https://developers.xsolla.com/es/api/subscriptions/plans/get-plans.md): Muestra todos los planes de suscripción. ### Crear plan - [POST /projects/{project_id}/subscriptions/plans](https://developers.xsolla.com/es/api/subscriptions/plans/create-plan.md): Crea un plan de suscripción. ### Desactivar plan - [DELETE /projects/{project_id}/subscriptions/plans/{plan_id}](https://developers.xsolla.com/es/api/subscriptions/plans/disable-plan.md): Desactiva un plan de suscripción. ### Activar plan - [PATCH /projects/{project_id}/subscriptions/plans/{plan_id}](https://developers.xsolla.com/es/api/subscriptions/plans/enable-plan.md): Activa un plan de suscripción. ### Actualizar plan - [PUT /projects/{project_id}/subscriptions/plans/{plan_id}](https://developers.xsolla.com/es/api/subscriptions/plans/update-plan-parameters.md): Actualiza los parámetros del plan de suscripción. ### Eliminar plan - [DELETE /projects/{project_id}/subscriptions/plans/{plan_id}/delete](https://developers.xsolla.com/es/api/subscriptions/plans/delete-plan.md): Elimina un plan de suscripción. ## Productos ### Obtener productos - [GET /projects/{project_id}/subscriptions/products](https://developers.xsolla.com/es/api/subscriptions/products/get-products.md): Muestra todos los productos basados en suscripción. ### Crear producto - [POST /projects/{project_id}/subscriptions/products](https://developers.xsolla.com/es/api/subscriptions/products/create-product.md): Crea un producto basado en suscripción. ### Eliminar producto - [DELETE /projects/{project_id}/subscriptions/products/{product_id}](https://developers.xsolla.com/es/api/subscriptions/products/delete-product.md): Elimina un producto basado en suscripción. ### Actualizar producto - [PUT /projects/{project_id}/subscriptions/products/{product_id}](https://developers.xsolla.com/es/api/subscriptions/products/update-product.md): Actualiza un producto basado en suscripción. ## Subscription management ### Obtener suscripciones - [GET /merchants/{merchant_id}/subscriptions](https://developers.xsolla.com/es/api/subscriptions/subscriptions/get-subscriptions.md): 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. 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. ### Obtener suscripción - [GET /projects/{project_id}/subscriptions/{subscription_id}](https://developers.xsolla.com/es/api/subscriptions/subscriptions/get-subscription.md): Obtiene detalles de una suscripción específica mediante un ID. ### Actualizar suscripción - [PUT /projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}](https://developers.xsolla.com/es/api/subscriptions/subscriptions/update-subscription.md): Actualiza una suscripción al cambiar su estado (active, canceled o non_renewing) o al aplazar la próxima fecha de facturación. ## Pagos ### Obtener monedas - [GET /projects/{project_id}/subscriptions/currencies](https://developers.xsolla.com/es/api/subscriptions/payments/get-currencies.md): Muestra todas las monedas de suscripción admitidas. ### Obtener pagos - [GET /projects/{project_id}/subscriptions/payments](https://developers.xsolla.com/es/api/subscriptions/payments/get-payments.md): Muestra todos los pagos de suscripción. ### Obtener pagos del usuario - [GET /projects/{project_id}/users/{user_id}/subscriptions/payments](https://developers.xsolla.com/es/api/subscriptions/payments/get-user-payments.md): Muestra todos los pagos hechos por un usuario específico. ## Promociones ### Obtener lista de promociones - [GET /merchants/{merchant_id}/promotions](https://developers.xsolla.com/es/api/subscriptions/promotions/get-promotions-list.md): Listado de todas las promociones. AvisoEsta 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. ### Crear promoción - [POST /merchants/{merchant_id}/promotions](https://developers.xsolla.com/es/api/subscriptions/promotions/create-promotion.md): Crear una nueva campaña de cupones. AvisoEsta 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. ### Eliminar promoción - [DELETE /merchants/{merchant_id}/promotions/{promotion_id}](https://developers.xsolla.com/es/api/subscriptions/promotions/delete-promotion.md): Elimina una promoción. Solo puedes eliminar promociones con enabled = false. AvisoEsta 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. ### Obtener promoción - [GET /merchants/{merchant_id}/promotions/{promotion_id}](https://developers.xsolla.com/es/api/subscriptions/promotions/get-promotion.md): Recupera una promoción. AvisoEsta 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. ### Actualizar promoción - [PUT /merchants/{merchant_id}/promotions/{promotion_id}](https://developers.xsolla.com/es/api/subscriptions/promotions/update-promotion.md): Actualiza una promoción. Si la promoción es de solo lectura (read_only = true), no se le permite cambiar el parámetro project_id. AvisoEsta 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. ### Obtener los sistemas de pago - [GET /merchants/{merchant_id}/promotions/{promotion_id}/payment_systems](https://developers.xsolla.com/es/api/subscriptions/promotions/get-payment-systems.md): Obtiene los sistemas de pago admitidos para una promoción. Si la lista está vacía, la promoción se aplicará a todos los sistemas de pago. AvisoEsta 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. ### Establecer sistemas de pago - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/payment_systems](https://developers.xsolla.com/es/api/subscriptions/promotions/set-payment-systems.md): Establece los sistemas de pago admitidos para una promoción. Si la lista está vacía, la promoción se aplicará a todos los sistemas de pago. Si la promoción es de solo lectura (read_only = true), no puede llamar a este método. 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. ### Obtener periodos de validez - [GET /merchants/{merchant_id}/promotions/{promotion_id}/periods](https://developers.xsolla.com/es/api/subscriptions/promotions/get-validity-periods.md): Obtiene rangos de fecha/hora cuando una promoción es válida. Aviso Esta llamada API no contiene el parámetro de rutaproject_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. ### Establecer periodos de validez - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/periods](https://developers.xsolla.com/es/api/subscriptions/promotions/set-validity-periods.md): Establece los rangos de fecha y hora en los que una promoción es válida. Si la promoción es de solo lectura (read_only = true), no puede editar los períodos existentes, pero puede agregar otros nuevos. Aviso Esta llamada API no contiene el parámetro de rutaproject_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. ### Revisar promoción - [GET /merchants/{merchant_id}/promotions/{promotion_id}/review](https://developers.xsolla.com/es/api/subscriptions/promotions/review-promotion.md): Debes revisar una promoción antes de activarla. Este método devuelve la lista de errores, si los hay. 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. ### Obtener recompensas - [GET /merchants/{merchant_id}/promotions/{promotion_id}/rewards](https://developers.xsolla.com/es/api/subscriptions/promotions/get-rewards.md): Obtiene la lista de recompensas asociadas con una promoción. Aviso Esta llamada API no contiene el parámetro de rutaproject_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. ### Establecer recompensas - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/rewards](https://developers.xsolla.com/es/api/subscriptions/promotions/set-rewards.md): Establece las recompensas de una promoción. Si la promoción es de solo lectura (read_only = true), no puedes actualizar las recompensas. 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. ### Obtener asunto - [GET /merchants/{merchant_id}/promotions/{promotion_id}/subject](https://developers.xsolla.com/es/api/subscriptions/promotions/get-subject.md): Obtiene información sobre el tema de una promoción. Aviso Esta llamada API no contiene el parámetro de rutaproject_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. ### Establecer asunto - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/subject](https://developers.xsolla.com/es/api/subscriptions/promotions/set-subject.md): Establece el asunto de una promoción. Si la promoción es de solo lectura (read_only = true), no se puede actualizar el asunto. El asunto puede tomar los siguientes valores: purchase, o items, o packages. 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. ### Cambiar promoción - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/toggle](https://developers.xsolla.com/es/api/subscriptions/promotions/toggle-promotion.md): Alterna el estado de una promoción de enabled a disabled y viceversa. 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. ## Cupones ### Crear campaña - [POST /merchants/{merchant_id}/coupon_promotions](https://developers.xsolla.com/es/api/subscriptions/coupons/create-campaign.md): Crear una nueva campaña de cupones. AvisoEsta 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. ### Añadir cupón a la campaña - [POST /merchants/{merchant_id}/coupon_promotions/{campaign_id}/coupons](https://developers.xsolla.com/es/api/subscriptions/coupons/add-coupon-to-campaign.md): Agregue un código de cupón a una campaña de cupones. AvisoEsta 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. ### Adjuntar campaña a la promoción - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/coupons](https://developers.xsolla.com/es/api/subscriptions/coupons/attach-campaign-to-promotion.md): Adjunte una campaña de cupones a una promoción específica. AvisoEsta 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. ### Obtener cupón - [GET /projects/{project_id}/coupons/{code}/details](https://developers.xsolla.com/es/api/subscriptions/coupons/get-coupon.md): Obtén los detalles del cupón mediante su código. ### Canjear cupón - [POST /projects/{project_id}/coupons/{code}/redeem](https://developers.xsolla.com/es/api/subscriptions/coupons/redeem-coupon.md): Canjear un cupón mediante su código. ## Subscription management ### List subscriptions - [GET /api/user/v1/management/projects/{project_id}/subscriptions](https://developers.xsolla.com/es/api/subscriptions/subscription-management/list-subscriptions.md) ### Get management settings - [GET /api/user/v1/management/projects/{project_id}/subscriptions/settings](https://developers.xsolla.com/es/api/subscriptions/subscription-management/get-management-settings.md) ### Get subscription - [GET /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}](https://developers.xsolla.com/es/api/subscriptions/subscription-management/get-management-subscription.md) ### Activate subscription - [PUT /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/activate](https://developers.xsolla.com/es/api/subscriptions/subscription-management/activate-subscription.md) ### Cancel subscription - [PUT /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/cancel](https://developers.xsolla.com/es/api/subscriptions/subscription-management/cancel-subscription.md) ### Get change plan link - [POST /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/change_plan](https://developers.xsolla.com/es/api/subscriptions/subscription-management/get-change-plan-link.md) ### Get payment account - [GET /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_account](https://developers.xsolla.com/es/api/subscriptions/subscription-management/get-payment-account.md) ### Manage payment account - [POST /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_account/manage](https://developers.xsolla.com/es/api/subscriptions/subscription-management/manage-payment-account.md) ### List payment accounts - [GET /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_accounts](https://developers.xsolla.com/es/api/subscriptions/subscription-management/list-payment-accounts.md) ### Link payment account - [POST /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_accounts](https://developers.xsolla.com/es/api/subscriptions/subscription-management/link-payment-account.md) ### Unlink payment account - [DELETE /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_accounts/{payment_account_id}](https://developers.xsolla.com/es/api/subscriptions/subscription-management/unlink-payment-account.md) ### List plans for change - [GET /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/plans_for_change](https://developers.xsolla.com/es/api/subscriptions/subscription-management/list-plans-for-change.md) ### Get plan for change - [GET /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/plans_for_change/{plan_id}](https://developers.xsolla.com/es/api/subscriptions/subscription-management/get-plan-for-change.md)