Sign in

v1

latestOpenAPI 3.1.02026-07-245178279.0 KB
Suscripciones

Actualizar una suscripción

Este endpoint permite actualizar los detalles de una suscripción existente. Es útil para realizar cambios como actualizar el método de pago entre otros.

patch/api/v1/merchants/subscriptions/{subscription_id}

Path parameters

subscription_idstring required
Example:97dd4a78-8fa2-4002-9ab0-b329dbf16acd

ID único de la suscripción que se desea actualizar.

Headers

X-API-keystring required

Clave de autenticación para acceder a la API.

Request body

plan_codestring required

Código único del plan asociado a la suscripción.

Example request

{
  "billing_address": {
    "address1": "presa angostura 36PH",
    "city": "CDMX",
    "country_code": "MX",
    "email": "efren.gl@gmail.com",
    "first_name": "efren",
    "last_name": "garcia",
    "state_code": "MX"
  },
  "metadata": {
    "site_domain": "https://www.ee.com"
  },
  "payer_info": {
    "email": "juan.perez@deuna.com",
    "last_name": "Perez",
    "name": "Juan"
  },
  "payment_source": {
    "card_info": {
      "card_holder": "visa",
      "card_id": "8d369b6e-113a-4640-9e63-dc29957fc86a"
    },
    "method_type": "credit_card"
  },
  "plan_code": "plan_basico",
  "shipping_address": {
    "address1": "Calle Falsa 123",
    "city": "Cuenca",
    "country_code": "EC",
    "email": "juan.perez@deuna.com",
    "first_name": "Juan",
    "last_name": "Pérez",
    "state_code": "A"
  },
  "webhooks_urls": {
    "notify_order": "https://api.deuna.io/webhook",
    "notify_update_subscription": "https://api.deuna.io/webhook"
  }
}

Response

Respuesta exitosa.

activated_atstring date-time

Fecha de activación.

auto_renewboolean

Indica si la suscripción se renueva automáticamente.

canceled_atstring date-time

Fecha de cancelación.

created_atstring date-time

Fecha y hora de creación.

currencystring

Moneda de la suscripción.

current_period_ends_atstring date-time

Fin del periodo actual.

current_period_started_atstring date-time

Inicio del periodo actual.

expires_atstring date-time

Fecha de expiración.

plan_codestring

Código del plan asociado.

remaining_billing_cyclesinteger

Ciclos de facturación restantes.

statusstring

Estado inicial de la suscripción.

subscription_idstring uuid

ID único de la suscripción creada.

total_billing_cyclesinteger

Número total de ciclos de facturación.

updated_atstring date-time

Fecha de última actualización.

Example response

{
  "activated_at": "2024-12-01T13:00:00Z",
  "auto_renew": true,
  "canceled_at": "2024-12-01T13:00:00Z",
  "created_at": "2024-12-01T13:00:00Z",
  "currency": "USD",
  "current_period_ends_at": "2024-12-01T13:00:00Z",
  "current_period_started_at": "2024-12-01T13:00:00Z",
  "expires_at": "2024-12-01T13:00:00Z",
  "payer_info": {
    "email": "juan.perez@deuna.com",
    "user_id": "isoososos"
  },
  "plan_code": "plan_basico",
  "remaining_billing_cycles": 1,
  "status": "active",
  "subscription_id": "97dd4a78-8fa2-4002-9ab0-b329dbf16acd",
  "total_billing_cycles": 12,
  "updated_at": "2024-12-01T13:00:00Z"
}