Step 2a - Connect with your free trial or freemium sign-up process

Use case: After registration, your customers start with a free subscription, with or without a time limit.

This is achieved with the two API calls described below.

Step 1 - Add the Customer

Just after the user account creation process is complete in your web application, declare a new Customer using the API.

POST https://api-42.proabono.com/v1/Customer
{
  "ReferenceSegment": "DEMO-EUR",
  "ReferenceCustomer": "cust-42",
  "Name": "John Doe",
  "Language": "en"
}

Parameters	Descriptions
ReferenceSegment	The Segment is where your Customer is stored. When your business grows larger, you may need an extra segment. For now, just use the one in the sample above.
ReferenceCustomer	Unique reference for that Customer Recommanded: use your internal id + a prefix (like cust-42) That way, no need to store an extra field in your database and you can deduce the ReferenceCustomer from your existing data.
Name	Your internal customer name Never displayed to the customer.
Language	(optional) the Customer language

More information and additional parameters in the API Reference.

Step 2 - Create the subscription

When the customer is successfully added, create their free subscription.
This step assumes you already created a free offer in the Catalog section beforehand.

POST https://api-42.proabono.com/v1/Subscription
{
  "ReferenceCustomer": "cust-42",
  "ReferenceOffer": "offer-free",
  "TryStart": true,
}

Parameters	Descriptions
ReferenceCustomer	Unique reference for that Customer Recommanded: use your internal id + a prefix (like cust-42) That way, no need to store an extra field in your database and you can deduce the ReferenceCustomer from your existing data.
ReferenceOffer	The reference of the Offer for the free plan Create it in the Catalog section..

More information and additional parameters in the API Reference.