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

frequencyUnits

Number

Número de unidades de frecuencia entre cuotas. Por ejemplo: frequency = Yearly y frequencyUnits = 2 significa cada 2 años.

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.

customer

String

El _id del cliente

code

String

The unique code used in the customer-facing link to the subscription.

lines

The line items billed by the subscription. A request that only sends amount and description gets a single recurring line built from them.

totalsRecurring

The totals of each recurring invoice. total is the amount charged each billing period.

totalsFirstInvoice

The totals of the first invoice, which also includes any one-time lines.

billToCustomer

String

El _id del cliente a facturar.

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",
  "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": {}
  },
  "deleted": false
}