Get Suscripción

Usa esto cuando necesites una suscripción tal como la tiene Hyfin, mediante su _id.


The following endpoint can be used to retrieve the details of a Suscripción within the Hyfin application.


Punto Final

The following endpoint can be used to retrieve a Suscripción. You must replace the {base_url} , {_id} and {site_id} variables with the appropriate values.

GET
{base_url}/api/v4/site/{site_id}/subscription/{_id}
Solicitud
Ningún cuerpo es necesario para esta llamada de API
Respuesta
Campo
Tipo
Descripción
_id
String
El id que asignamos a esta suscripción. Omítelo al crear una suscripción y envíalo al actualizar una.
externalId
String
Tu propio id para esta suscripción, desde tu software. Envía de nuevo el mismo externalId para actualizar esta suscripción en lugar de agregar una nueva. Usamos este valor para hacer la coincidencia, pero no evitamos duplicados, así que manténgalo único dentro del sitio.
frequency
String
La frecuencia de facturación. Bi-Weekly cobra cada 14 días y Quarterly cada 3 meses. Semi-Monthly cobra dos veces al mes, el día de inicio y el día del mes que está a 14 días de distancia: un inicio el día 1 cobra el 1 y el 15, y un inicio el día 20 cobra el 20 y el 6. Semi-Annually cobra cada 6 meses en el día de inicio. Una suscripción Monthly iniciada del 29 al 31 cobra el último día de un mes más corto y después se queda en ese día.
One of Daily, Weekly, Bi-Weekly, Semi-Monthly, Monthly, Quarterly, Semi-Annually, Yearly
frequencyUnits
Number
Número de unidades de frecuencia entre cada pago. Ej.: frequency = Yearly y frequencyUnits = 2 significa cada 2 años. Solo aplica para Daily, Weekly, Monthly y Yearly, y se ignora para las demás frecuencias.
startDate
La fecha de inicio de la suscripción. Si se deja en blanco, se establecerá cuando el cliente confirme su método de pago. Una fecha sin hora. Si se envía una hora o zona horaria con ella, se descarta, no se convierte, por lo que la fecha permanece tal como se escribió. 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.
status
String
El estado actual de la suscripción.
One of pending, active, paused, failed, closed
webhookUrl
String
La URL a la que se envía una publicación cuando se realizan ciertas acciones en la suscripción. Se envía un webhook cuando un pago alcanza un nuevo estado, y cuando un mensaje de texto, correo electrónico o mensaje de WhatsApp se envía, se entrega, se lee, se retrasa o falla, o cuando el cliente hace clic en el enlace de pago.
attachmentRefs
Una lista de adjuntos.
send
A quién se envía Suscripción, por canal. Un canal que incluyas se usa tal como lo indiques, y una lista vacía ([]) desactiva ese canal. Un canal que omitas conserva los destinatarios que Suscripción ya tiene, o se llena con los contactos del cliente, según el control de notificaciones del cliente, cuando aún no tiene ninguno. En una creación, omite send para que los contactos del cliente decidan cada canal cuando se envíe Suscripción. En una actualización, omitirlo conserva los destinatarios ya elegidos. Una lectura devuelve send.to como null hasta que se hayan elegido destinatarios. billTo.emails y billTo.sms siguen siendo la anulación de quién recibe esos canales, pero nunca reactivan un canal que send desactivó. Cada orden de compra que genera la suscripción se envía a estos destinatarios, tal como estén cuando se genera esa orden de compra, por lo que un cambio se aplica a las órdenes de compra generadas después.
customer
String
El _id del cliente
code
String
El código único que se usa en el enlace de la suscripción visible para el cliente.
lines
Los conceptos de cada orden de compra que crea la suscripción. Una solicitud que solo envía amount y description obtiene una única línea recurrente creada a partir de ellos.
totalsRecurring
Los totales de cada orden de compra recurrente. total es el monto cobrado en cada periodo de facturación.
totalsFirstInvoice
Los totales de la primera orden de compra, que también incluye las líneas de pago único.
billToCustomer
String
El _id del cliente que recibe y paga la orden de compra.
billTo
Reemplazos opcionales para la sección Facturar a de la orden de compra. Si se proporciona billToCustomer, este objeto se combinará con la información del cliente y se puede usar para reemplazar campos específicos. Si no se proporciona billToCustomer, los campos de este objeto se usarán como la información de Facturar a en la orden de compra.
soldTo
Opciones adicionales para la sección de Vendido a / Cliente de la orden de compra.
deleted
Boolean
Esta bandera representa si el registro ha sido eliminado y ya no está disponible para ser utilizado.
Sample Response
			
{
  "_id": "61f32dc2f62bdc6a48945067",
  "externalId": "439772921",
  "code": "KA39TI45JLMN",
  "customer": "61f32dc2f62bdc6a48951255",
  "billToCustomer": "61f32dc2f62bdc6a48951255",
  "lines": [
    {
      "name": "",
      "description": "Gold+ Plan",
      "qty": 1,
      "unitPrice": 3499,
      "total": 3499,
      "isRecurring": true
    }
  ],
  "totalsRecurring": {
    "taxes": 0,
    "discounts": 0,
    "total": 3499
  },
  "totalsFirstInvoice": {
    "taxes": 0,
    "discounts": 0,
    "total": 3499
  },
  "frequency": "Monthly",
  "frequencyUnits": 1,
  "startDate": "2022-02-23",
  "numberOfPayments": null,
  "status": "active",
  "webhookUrl": "https://yourcompany.com/webhook",
  "attachmentRefs": {
    "internal": [],
    "external": []
  },
  "billTo": {
    "name": "John Doe",
    "attn": "",
    "address": {},
    "emails": [],
    "sms": []
  },
  "soldTo": {
    "name": "John Doe",
    "attn": "",
    "address": {}
  },
  "send": {
    "to": {
      "email": [
        {
          "name": "John Doe",
          "address": "johndoe@abc.com",
          "as": "to",
          "contact": "6839e415564d3cc216032361"
        }
      ],
      "sms": [],
      "whatsApp": []
    }
  },
  "deleted": false
}


		

Ver también