Add/Update Suscripción


The following endpoint can be used to add or update a Suscripción within the Hyfin application. When a Suscripción is added to Hyfin, a request will be automatically generated and the customer will be notified via text message, email or both based on the notification options set on the customer record. After submitting their payment method, the customer will automatically be charged based on the frequency of the recurring payment.

If the customer is viewing the Suscripción on their device and it gets updated, a message will display letting the customer know the Suscripción has been updated and the new version of the Suscripción will automatically be displayed on the customers device.


Punto Final

The following endpoint can be used to add or update a Suscripción. You must replace the {base_url} and {site_id} variable with the site id that was provided when the site was created.

POST
{base_url}/api/v4/site/{site_id}/subscription/addUpdate

Solicitud
Campo
Tipo
Descripción
id
String
El id de la suscripción. Este campo es generado automáticamente por el sistema y no es necesario al crear una nueva suscripción, pero es necesario al actualizar una suscripción existente.
frequency
String
La frecuencia de facturación.
One of `Daily`, `Weekly`, `Bi-Weekly`, `Semi-Monthly`, `Monthly`, `Quarterly`, `Semi-Annually`, `Yearly`
frequencyUnits
Number
Number of frequency units between installments. Ex: `frequency = Yearly` and `frequency_units = 2` means every 2 years.
customer
Una referencia al registro del cliente.
startDate
Date
La fecha de inicio de la suscripción. Si se deja en blanco, se establecerá cuando el cliente confirme su método de pago. Format = YYYY-MM-DD
numberOfPayments
Number
El número de pagos a realizar. Si se deja en blanco, la suscripción continúa indefinidamente o hasta que se cierre manualmente.
webhookUrl
String
La URL a la que se enviará la publicación cuando se realicen ciertas acciones en la suscripción.
attachmentRefs
Una lista de adjuntos.
billToCustomer
El cliente a facturar, si es diferente al cliente.
billTo
Opciones adicionales para la sección de Facturar a de la factura. Si se proporciona bill_to_customer, este objeto se fusionará con la información del cliente y se podrá utilizar para anular campos específicos. Si no se proporciona bill_to_customer, los campos de este objeto se utilizarán como la información de Facturar a en la factura.
soldTo
Opciones adicionales para la sección de Vendido a / Cliente de la factura.
deleted
Boolean
Esta bandera representa si el registro ha sido eliminado y ya no está disponible para ser utilizado.
Sample Request
			
{
  "_id": "61f32dc2f62bdc6a48945067",
  "description": "Gold+ Plan",
  "amount": 34.99,
  "frequency": "Monthly",
  "frequency_units": 1,
  "customer": {
    "_id": "61f32dc2f62bdc6a48951255",
    "first_name": "John",
    "last_name": "Doe",
    "mobile_phone": "111-222-3333",
    "email": "johndoe@abc.com"
  },
  "webhook_url": "https://yourcompany.com/webhook"
}


		
Respuesta
Campo
Tipo
Descripción
success
Boolean
Whether the record was added or updated successfully.
action
String
Informs whether the record was added or updated. Will only be returned if `success` is `true`.
One of `added`, `updated`
_id
String
The auto generated id assigned to the record.
errors
String [ ]
A list of errors. Will only be returned if `success` is `false`.
Sample Response (Successful)
			
{
  "success": true,
  "action": "added",
  "_id": "60f720d248f143332af022e0"
}


		
Sample Response (Failed)
			
{
  "success": false,
  "errors": [
    "invalid field2",
    "missing field_name"
  ]
}