Add/Update Abonnement

The following endpoint can be used to add or update a Abonnement within the Hyfin application. When a Abonnement is added to Hyfin, a request will be automatically generated and the customer will be notified via text message, email or both based on the notification options set on the customer record. 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 Abonnement on their device and it gets updated, a message will display letting the customer know the Abonnement has been updated and the new version of the Abonnement will automatically be displayed on the customers device.

Point de terminaison

The following endpoint can be used to add or update a Abonnement. 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"
}


		

			
{
  "success": false,
  "errors": [
    "invalid field2",
    "missing field_name"
  ]
}