API Reference

Suscripciones

Los webhooks suelen mantener una estructura de información consistente a través de varias instancias, siendo el factor diferenciador principal el evento único de webhook que provoca su activación. En esencia, aunque el formato de los datos centrales permanece uniforme, es el evento distintivo, como un registro de usuario o una confirmación de compra, lo que otorga a cada webhook su propósito específico y relevancia dentro de la aplicación o sistema más amplio.

{
   "subscription":{
     "id" : "9c799dbc-c453-4798-8a1f-0ec386dba964",
     "name" : "Test subs",
     "status" : "created",
     "description" : "Test subs",
     "internal_id" : null,
     "plan_id" : null,
     "coupon_id" : null,
     "reference_price_in_cents" : "200000",
     "currency" : "COP",
     "amount_in_cents" : 100000,
     "cicle_frequency" : "daily",
     "cicles" : 1000,
     "current_cicle" : 0,
     "allows" : {
       "cards" : false,
       "accounts" : false,
       "card_extra" : false,
       "realtime" : false,
       "pse" : false,
       "transfiya" : false
     },
     "suggest_auto_debit" : 0,
     "start_date" : "2024-07-05T00:00:00.000000Z",
     "end_date" : null,
     "payment_mode" : "request",
     "trial" : {
       "has_trial" : false,
       "start_trial_date" : "2024-07-08T17:58:33.710663Z",
       "trial_days" : null
     },
     "remember_to_pay_before" : 0,
     "cancel_after_no_payment_before" : 0,
     "complex_payments" : [],
     "features" : [],
     "metadata" : null,
     "created_at" : "2024-07-08T17:58:33.000000Z",
     "updated_at" : "2024-07-08T17:58:33.000000Z",
     "customer":{
       "first_name":"Daniela",
       "last_name":"Lozano",
       "email": "[email protected]",
       "phone":"+573155555555"
     },
     "plan" : null,
   },
  "event": {
    "type":"subscription.created",
    "timestamp":1689262938
  }
}

Eventos

Esta es la lista de eventos disponibles.

  • subscription.created
  • subscription.canceled
  • subscription.pass_due
  • subscription.expired
  • subscription.rejected
  • subscription.paid
  • subscription.deleted

Estados de la Suscripción

  • created
  • rejected
  • expired
  • unpaid
  • canceled
  • pass_due
  • active
  • deleted