Use this when a customer should be billed the same amount on a schedule, such as monthly service.
The following endpoint can be used to add or update a Subscription within the Hyfin application. When a Subscription is added to Hyfin, a request will be automatically generated and the customer will be notified via text message, email or both, as described under Who gets notified below. After submitting their payment method, the customer will automatically be charged based on the frequency of the recurring payment.
If the customer is viewing the Subscription on their device and it gets updated, a message will display letting the customer know the Subscription has been updated and the new version of the Subscription will automatically be displayed on the customers device.
Each customer is under exactly one notification control, worked out from the site and the customer. It is never stored and cannot be set directly.
On API v4:
The following endpoint can be used to add or update a Subscription. You must replace the {base_url} and {site_id} variable with the site id that was provided when the site was created.
{
"externalId": "439772921",
"description": "Gold+ Plan",
"amount": 3499,
"frequency": "Monthly",
"frequencyUnits": 1,
"customer": {
"externalId": "39772634",
"firstName": "John",
"lastName": "Doe",
"mobilePhone": "111-222-3333",
"email": "johndoe@abc.com"
},
"webhookUrl": "https://yourcompany.com/webhook"
}
{
"success": true,
"action": "added",
"_id": "60f720d248f143332af022e0",
"updatedAt": "2025-05-30T19:19:44.143Z",
"link": "https://site.url/KA39T1A45JL"
}