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} , {external_id} and {site_id} variables with the appropriate values.
GET
{base_url}/api/v3.1/site/{site_id}/subscription/{external_id}
Demande
Aucun corps n'est requis pour cet appel API
Réponse
Champ
Type
Description
external_id
String
Le numéro d'abonnement unique du système/base de données source. Si nous détectons un enregistrement avec le même external_id, il sera mis à jour, sinon il sera ajouté.
id
String
The id of the subscription, assigned by the system.
description
String
Une brève description des produits/services sur l'abonnement utilisé dans la demande de paiement affichée au client.
amount
Number
Le montant à facturer pour chaque période de facturation. Format = 0.00
frequency
String
La fréquence de facturation.
One of Daily, Weekly, Bi-Weekly, Semi-Monthly, Monthly, Quarterly, Semi-Annually, Yearly
One of Daily, Weekly, Bi-Weekly, Semi-Monthly, Monthly, Quarterly, Semi-Annually, Yearly
customer
Une référence au dossier du client.
start_date
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
number_of_payments
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
One of pending, active, paused, failed, closed
active
Boolean
Que la souscription soit active. Le paramétrage à false fermera de manière irréversible la souscription si le client l'a déjà acceptée.
Default = true
Default = true
reference_number
String
The unique reference number assigned to the subscription by the system. It is also the code in the customer-facing link.
invoices
The Factures billed by the subscription so far, each without its customer (it is the subscription's own customer). Empty until the first one is billed.
created_at
Date
The date the subscription was created.
updated_at
Date
The date the subscription was last updated.
Sample Response
{
"id": "61f32dc2f62bdc6a48945067",
"external_id": "439772921",
"reference_number": "N7E6NSZ4A816",
"description": "Gold+ Plan",
"amount": 9.97,
"frequency": "Weekly",
"start_date": "2022-02-23",
"number_of_payments": "",
"invoices": [
{
"external_id": "39772634",
"invoice_number": "",
"totals": {
"total": 9.97,
"tax": 0
},
"notifications": [],
"lines": [],
"description": "Gold+ Plan",
"invoice_date": "2022-02-23",
"due_date": "2022-02-23",
"customer_memo": "",
"internal_memo": "",
"active": true,
"payments": [
{
"external_id": "62331255",
"gateway_transaction_id": "574823902",
"display_name": "Visa",
"amount": 9.97,
"tip": 0,
"tax": 0,
"fee": 0,
"paid_on": "2022-02-23T11:29:01-06:00",
"payment_type": "payment_card",
"payment_sub_type": "visa",
"status": "captured",
"is_refund": false
}
]
}
],
"status": "active",
"customer": {
"external_id": "72345322",
"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,
"created_at": "2025-05-30T19:19:44.143Z",
"updated_at": "2025-05-30T19:19:44.143Z"
}