Developer Area

Context

In many cases, your customers will have subscribed to an offer with the possibility to activate options, use a certain number of resources, etc. For example, your customer has a subscription that includes 3 licenses for software usage. But they can add an additional license at any time.
In this case, you need to notify ProAbono so that any pricing changes can be applied.

Prerequisites

To make it work, you need to have:

• At least one customer with an active subscription.
• The customer’s subscription must contain at least one modifiable feature.

Procedure

1/ List the subscription features

Request

POST https://api-{IdBusiness}.proabono.com/v1/Usage?ReferenceCustomer={ReferenceCustomer}
{
  "ReferenceCustomer": "{ReferenceCustomer}",
  "DateStamp": "{Current Date YYYY-MM-DD}TZ"
}

ProAbono will list all the features related to the customer’s subscription and provide 2 quantities:

• Quantity included in the subscription for that feature
• Current quantity for that feature

2/ Modify the quantity or enable/disable a feature

Example request for a quantity-based feature: Limitation or Consumption

POST https://api-{IdBusiness}.proabono.com/v1/Usage
{
  "ReferenceFeature": "{ReferenceFeature}",
  "ReferenceCustomer": "{ReferenceCustomer}",
  "Increment": 5,
  "DateStamp": "{Current Date YYYY-MM-DD}TZ"
}

OR
Example request for an activation-based feature: OnOff

POST https://api-{IdBusiness}.proabono.com/v1/Usage
{
  "ReferenceFeature": "{ReferenceFeature}",
  "ReferenceCustomer": "{ReferenceCustomer}",
  "IsEnabled" : true,
  "DateStamp": "{Current Date YYYY-MM-DD}TZ"
}