Get Abonnement

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

String

L'identifiant de l'abonnement. Ce champ est généré automatiquement par le système et n'est pas requis lors de la création d'un nouvel abonnement, mais il est requis lors de la mise à jour d'un abonnement existant.

frequency

String

La fréquence de facturation.
One of `Daily`, `Weekly`, `Bi-Weekly`, `Semi-Monthly`, `Monthly`, `Quarterly`, `Semi-Annually`, `Yearly`

customer

Une référence au dossier du client.

startDate

Date

La date de début de l'abonnement. Si laissée vide, elle sera définie lorsque le client confirme son mode de paiement. 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 où envoyer les données lorsque certaines actions sont effectuées sur l'abonnement.

attachmentRefs

Une liste de pièces jointes.

billToCustomer

Le client à facturer, si différent du client.

billTo

Options de remplacement facultatives pour la section Destinataire de la facture. Si bill_to_customer est fourni, cet objet sera fusionné avec les informations du client et pourra être utilisé pour remplacer des champs spécifiques. Si bill_to_customer n'est pas fourni, les champs de cet objet seront utilisés comme informations de Destinataire 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",
  "description": "Gold+ Plan",
  "amount": 9.97,
  "frequency": "Weekly",
  "start_date": "2022-02-23",
  "number_of_payments": "",
  "end_date": null,
  "invoices": [
    {
      "_id": "61f32dc2f62bdc6a48951255",
      "invoice_number": "",
      "totals": {
        "total": 9.97,
        "taxes": 0
      },
      "notifications": [],
      "lines": [],
      "description": "Gold+ Plan",
      "invoice_date": "2022-02-23",
      "due_date": "2022-02-23",
      "customer_memo": "",
      "internal_memo": "",
      "active": true,
      "payments": [
        {
          "_id": "62166eda3a8c0517866b9b46",
          "gateway_transaction_id": "574823902",
          "display_name": "Visa **** 4279",
          "amount": 9997,
          "tip": 0,
          "paid_on": "2022-02-23T11:29:01-06:00",
          "payment_type": "payment_card",
          "transaction_type": "capture",
          "tax": 0
        }
      ]
    }
  ],
  "status": "active",
  "customer": {
    "_id": "62166eda3a8c0517866b9r23",
    "first_name": "John",
    "last_name": "Doe",
    "account_name": null,
    "mobile_phone": "111-222-3333",
    "email": "johndoe@abc.com",
    "notification_options": {
      "notify_phone": true,
      "notify_email": false
    }
  },
  "active": true,
  "webhook_url": "https://yourcompany.com/webhook"
}