Skip to main content
PATCH
Actualizar suscripción

Autorizaciones

x-api-key
string
header
requerido

API key del API Gateway de Tapi. Requerida en todas las operaciones. Distinta por ambiente (desarrollo, homologación, producción).

x-authorization-token
string
header
requerido

Token TAPI JWT. Requerido en todas las operaciones. Se envía sin prefijo "Bearer". Ej: x-authorization-token: eyJhbGci...

Parámetros de ruta

id
string
requerido

ID público con prefijo sub_ o el mismo valor sin prefijo.

Ejemplo:

"sub_839d28e1-a175-40c7-a54b-55f6c17b7964"

Cuerpo

application/json
amount
number

Monto por ciclo en pesos (hasta 2 decimales, mínimo 0.01)

Rango requerido: x >= 0.01Debe ser un múltiplo de 0.01
description
string

Debe ser string (si no, 400).

additionalData
object

Datos adicionales propios del cliente. Debe ser un objeto plano; un escalar (string, número o booleano) devuelve 400 INVALID_REQUEST. No puede usar claves reservadas, que TapiPay escribe internamente: description, paymentMethods, productName, externalProductId, debtExpirationDate, overduePayment, allowPartialPayments, recurringDebt, debtReference. Si aparece alguna, la API responde 400 INVALID_REQUEST con details[].field = additionalData. Se persiste en la deuda (en ligas de pago, en la deuda asociada al link; en suscripciones, en las deudas generadas).

Ejemplo:
enforcePaymentOrder
boolean

Solo acepta true/false literal (si no, 400).

allowOverduePayment
boolean

Solo acepta true/false literal (si no, 400).

autopay
boolean

Solo acepta true/false literal (si no, 400). autopay: true y paymentMethods son excluyentes (400).

paymentMethods
enum<string>[]

Valores fuera del enum devuelven 400.

Opciones disponibles:
CASH,
CARD,
TRANSFER,
WALLET,
BANK_TRANSFER

Respuesta

Suscripción actualizada

data
object

description, additionalData y paymentMethods solo vienen si tienen valor. Una suscripción ACTIVE cuya fecha de fin ya pasó se devuelve como ENDED.

Ejemplo:
requestId
string