Module: FlowCl::Subscription

Defined in:
lib/flow_cl/subscription.rb

Instance Method Summary collapse

Instance Method Details

#add_coupon_subscription(id:, coupon_id:) ⇒ Object

Este servicio permite cancelar una suscripción. Existen formas de cancelar una suscripción:

  • inmediatamente. Es decir, en este instante

  • al terminar el perído vigente.

Si desea cancelar la suscripción inmediatamente, envíe el parámetro at_period_end con valor 0, si desea cancelarla al final del período vigente envíe el valor 1.



45
46
47
48
49
 
# File 'lib/flow_cl/subscription.rb', line 45

def add_coupon_subscription(id:, coupon_id:)
  path = 'api/subscription/addCoupon'

  private_post(path, { subscriptionId: id, couponId: coupon_id })
end

#change_trial(id:, trial_period_days:) ⇒ Object

Este servicio permite modificar los días de Trial de una suscripción. Sólo se puede modificar los días de Trial a una suscripción que aún no se ha iniciado o que todavía está vigente el Trial.



35
36
37
38
39
 
# File 'lib/flow_cl/subscription.rb', line 35

def change_trial(id:, trial_period_days:)
  path = 'api/subscription/changeTrial'

  private_post(path, { subscriptionId: id, trial_period_days: trial_period_days })
end

#create_subscription(params:) ⇒ Object

Este servicio permite crear una nueva suscripción de un cliente a un Plan. Para crear una nueva suscripción, basta con enviar los parámetros planId y customerId, los parám

  • subscription_start Fecha de inicio de la suscripción

  • couponId Identificador de cupón de descuento

  • trial_period_days Número de días de Trial



10
11
12
13
14
 
# File 'lib/flow_cl/subscription.rb', line 10

def create_subscription(params:)
  path = 'api/subscription/get'

  private_get(path, { params: params })
end

#delete_coupon_subscription(id:) ⇒ Object

Este servicio permite eliminar el descuento que tenga la suscripción. El eliminar el descuento de la suscripción, no elimina el descuento que podría tenar asociado el cliente.



53
54
55
56
57
 
# File 'lib/flow_cl/subscription.rb', line 53

def delete_coupon_subscription(id:)
  path = 'api/subscription/addCoupon'

  private_post(path, { subscriptionId: id })
end

#subscription(id:) ⇒ Object

Este servicio permite obtener los datos de una suscripción.



17
18
19
20
21
 
# File 'lib/flow_cl/subscription.rb', line 17

def subscription(id:)
  path = 'api/subscription/get'

  private_get(path, { subscriptionId: id })
end

#subscriptions(params: {}) ⇒ Object

Permite obtener la lista de suscripciones paginada de acuerdo a los parámetros de paginación. Además, se puede definir los siguientes filtros: filter: filtro por nombre del plan status: filtro por estado de la suscripción.



27
28
29
30
31
 
# File 'lib/flow_cl/subscription.rb', line 27

def subscriptions(params: {})
  path = 'api/subscription/get'

  private_get(path, params)
end