Get Abonnement

Utilisez ceci lorsque vous avez besoin d'un abonnement tel que Hyfin le possède, à partir de son _id.


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


Point de terminaison

The following endpoint can be used to retrieve a Abonnement. 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}
Demande
Aucun corps n'est requis pour cet appel API
Réponse
Champ
Type
Description
_id
String
L'identifiant que nous attribuons à cet abonnement. Omettez-le lors de la création d'un abonnement et envoyez-le lors de la mise à jour d'un abonnement.
externalId
String
Votre propre identifiant pour cet abonnement, provenant de votre logiciel. Envoyez à nouveau le même externalId pour mettre à jour cet abonnement au lieu d'en ajouter un nouveau. Nous faisons la correspondance sur cette valeur, mais nous n'empêchons pas les doublons; gardez-la donc unique au sein du site.
frequency
String
La fréquence de facturation. Bi-Weekly facture tous les 14 jours et Quarterly tous les 3 mois. Semi-Monthly facture deux fois par mois, le jour de début et le jour du mois situé à 14 jours d'écart : un début le 1er facture le 1er et le 15, et un début le 20 facture le 20 et le 6. Semi-Annually facture tous les 6 mois le jour de début. Un abonnement Monthly commencé du 29 au 31 est facturé le dernier jour d'un mois plus court et reste ensuite à ce jour.
One of Daily, Weekly, Bi-Weekly, Semi-Monthly, Monthly, Quarterly, Semi-Annually, Yearly
frequencyUnits
Number
Nombre d'unités de fréquence entre les versements. Ex. : frequency = Yearly et frequencyUnits = 2 signifie tous les 2 ans. S'applique uniquement à Daily, Weekly, Monthly et Yearly, et est ignoré pour les autres fréquences.
startDate
La date de début de l'abonnement. Si laissée vide, elle sera définie lorsque le client confirme son mode de paiement. Une date sans heure. Une heure ou un fuseau horaire envoyé avec elle est ignoré, et non converti, de sorte que la date reste telle qu'écrite. Format = YYYY-MM-DD
numberOfPayments
Number
Le nombre de versements à effectuer. Si laissé vide, l'abonnement se poursuit indéfiniment ou jusqu'à ce qu'il soit fermé manuellement.
status
String
Le statut actuel de l'abonnement.
One of pending, active, paused, failed, closed
webhookUrl
String
L'URL à laquelle envoyer une requête POST lorsque certaines actions sont effectuées sur l'abonnement. Un webhook est envoyé lorsqu'un paiement atteint un nouvel état, et lorsqu'un message texte, un courriel ou un message WhatsApp est envoyé, livré, lu, retardé ou échoue, ou lorsque le client clique sur le lien de paiement.
attachmentRefs
Une liste de pièces jointes.
send
À qui Abonnement est envoyé, par canal. Un canal que vous indiquez est utilisé tel quel, et une liste vide ([]) désactive ce canal. Un canal que vous omettez conserve les destinataires que Abonnement a déjà, ou est rempli à partir des contacts du client, selon le contrôle des notifications du client, lorsqu'il n'en a pas encore. Lors d'une création, omettez send pour laisser les contacts du client décider de chaque canal lors de l'envoi de Abonnement. Lors d'une mise à jour, l'omettre conserve les destinataires déjà choisis. Une lecture renvoie send.to à null tant que les destinataires n'ont pas été choisis. billTo.emails et billTo.sms demeurent le remplacement pour déterminer qui reçoit ces canaux, mais ne réactivent jamais un canal que send a désactivé. Chaque Facture générée par l'abonnement est envoyée à ces destinataires, tels qu'ils sont au moment où cette Facture est générée; un changement s'applique donc aux Factures générées par la suite.
customer
String
L'identifiant du client
code
String
Le code unique utilisé dans le lien vers l'abonnement destiné au client.
lines
Les lignes de chaque facture créée par l'abonnement. Une requête qui n'envoie que amount et description obtient une seule ligne récurrente construite à partir de ceux-ci.
totalsRecurring
Les totaux de chaque facture récurrente. total est le montant facturé à chaque période de facturation.
totalsFirstInvoice
Les totaux de la première facture, qui comprend également les lignes ponctuelles.
billToCustomer
String
Le _id du client qui reçoit et paie la facture.
billTo
Remplacements facultatifs pour la section Facturer à de la facture. Si billToCustomer est fourni, cet objet sera fusionné avec les renseignements du client et peut servir à remplacer des champs précis. Si billToCustomer n'est pas fourni, les champs de cet objet seront utilisés comme renseignements de facturation sur la facture.
soldTo
Options facultatives pour la section Expédié à / Client de la facture.
deleted
Boolean
Ce drapeau représente si l'enregistrement est supprimé et n'est plus disponible pour être utilisé.
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
}


		

Voir aussi