SiPagoDocs
Docs para IA

Conceptos de planes

Antes de crear o actualizar planes, tené en cuenta el siguiente comportamiento del recurso.

Información del comercio

Para crear planes es necesario contar con merchant_name y merchant_id. Estos valores se obtienen ingresando a https://portal.sipago.coop/ con las credenciales del comercio y consultando la sección Perfil, donde se muestra la información del comercio:

Información del Comercio en el perfil de Sipago: ID Merchant y Nombre del Merchant

merchant_name corresponde al campo Nombre del Merchant del portal; merchant_id corresponde al campo ID Merchant. Los demás campos (Comercio, ID Sucursal) no se usan en el body de creación de planes.

Tipos de precio (pricing_type)

TipoComportamientoamount
fixedTodos los suscriptores pagan la misma cuota.Obligatorio al crear el plan. Se puede modificar después (ver Actualizar plan).
dynamicNo hay un monto inicial: cada suscripción se cobra por un monto que se define individualmente.No aplica al crear el plan; se define por suscripción enviando next_amount en Actualizar suscripción.

Día de cobro (billing_day)

El comportamiento depende de billing_frequency:

  • monthly — billing_day es el día del mes (1-31). Si se omite, el día de cobro queda fijado al día en que cada usuario se suscribe (ej.: alguien que se suscribe el 23 paga el 23 de cada mes en adelante).
  • weekly — billing_day representa un día de la semana. Si se omite, el día de cobro queda fijado al día de la semana en que cada usuario se suscribe.
billing_dayDía
1Lunes
2Martes
3Miércoles
4Jueves
5Viernes
6Sábado
7Domingo
  • bimonthly, quarterly, yearly — billing_day y billing_month son obligatorios.

Prorrateo (prorate)

Solo aplica a planes con billing_day definido.

  • prorate: true — la primera cuota se cobra proporcional al momento de la suscripción; desde el siguiente ciclo se cobra la cuota completa. Ej.: un plan que cobra el día 1 de cada mes, si alguien se suscribe el 15, paga la mitad de la cuota ese día y la cuota completa el 1 del mes siguiente.
  • prorate: false — se cobra la cuota completa sin importar el día de suscripción.

Duración (billing_cycles)

  • Con billing_cycles — el plan tiene una cantidad fija de cobros.
  • Sin billing_cycles — el plan es indefinido, hasta que la suscripción se cancele.