Documentación de la API 3.1Documentación de la API 4.0 SimpleDocumentación de la API 4.0

Get Suscripción

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 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
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.
status
String
El estado actual de la suscripción.
One of pending, active, paused, failed, closed
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 orden de compra. Si se proporciona billToCustomer, este objeto se fusionará con la información del cliente y se podrá utilizar para anular campos específicos. Si no se proporciona billToCustomer, los campos de este objeto se utilizará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",
  "description": "Gold+ Plan",
  "amount": 997,
  "frequency": "Weekly",
  "startDate": "2022-02-23",
  "numberOfPayments": "",
  "endDate": null,
  "invoices": [
    {
      "_id": "61f32dc2f62bdc6a48951255",
      "invoiceNumber": "",
      "totals": {
        "total": 997,
        "taxes": 0
      },
      "notifications": [],
      "lines": [],
      "description": "Gold+ Plan",
      "invoiceDate": "2022-02-23",
      "dueDate": "2022-02-23",
      "customerMemo": "",
      "internalMemo": "",
      "payments": [
        {
          "_id": "62166eda3a8c0517866b9b46",
          "gatewayTransactionId": "574823902",
          "displayName": "Visa **** 4279",
          "amount": 997,
          "tip": 0,
          "paidOn": "2022-02-23T11:29:01-06:00",
          "paymentType": "payment_card",
          "transactionType": "capture",
          "tax": 0
        }
      ],
      "deleted": false
    }
  ],
  "status": "active",
  "customer": {
    "_id": "62166eda3a8c0517866b9r23",
    "firstName": "John",
    "lastName": "Doe",
    "accountName": null,
    "mobilePhone": "111-222-3333",
    "email": "johndoe@abc.com",
    "notificationOptions": {
      "notifyPhone": true,
      "notifyEmail": false
    }
  },
  "webhookUrl": "https://yourcompany.com/webhook",
  "deleted": false
}