In a subscription-based service, user permission management is tied to the subscription lifecycle, which means these permissions must be constantly updated whenever a subscription is created, canceled, suspended, restarted, when the plan changes, or whenever the subscription is modified. And when the sales team creates a new offer or a custom subscription for a specific customer, you have to handle those new cases as well.
Forget all that: the Usage API handles it for you.
It’s designed to eliminate tons of boilerplate code by telling you exactly what a customer is entitled to at any given moment.
Scalable and standardized, this API lets you integrate ProAbono into your web application in a durable, maintenance-free way, even as your commercial offers continuously evolve.
Furthermore this API also allows you to adjust your customers metrics and options, drastically simplifying usage-based billing.
Pre-requisite
You have to be familiar with the concept of Feature.
How to retrieve Usages
GET https://api-42.proabono.com/v1/Usages?ReferenceCustomer=cust-42
{
"Page": 1,
"SizePage": 10,
"Count": 3,
"TotalItems": 3,
"Items": [
{
"IdSubscription": 462457,
"ReferenceSegment": "demo-eur",
"ReferenceFeature": "users",
"ReferenceCustomer": "cust-42",
"TypeFeature": "Limitation",
"QuantityIncluded": 1,
"QuantityCurrent": 5,
"DatePeriodStart": "2025-06-07T23:54:20.00Z",
"DatePeriodEnd": "2025-07-07T23:54:20.00Z"
},
{
"IdSubscription": 462457,
"ReferenceSegment": "demo-eur",
"ReferenceFeature": "support-24",
"ReferenceCustomer": "cust-42",
"TypeFeature": "OnOff",
"IsIncluded": false,
"IsEnabled": true,
"DatePeriodStart": "2025-06-07T23:54:20.00Z",
"DatePeriodEnd": "2025-07-07T23:54:20.00Z"
},
...
More information and additional parameters in the API Reference.
When to use it
As recommended in the documentation, you should retrieve usages when the customer signs-in or after a successful Customer Workflow and store those for the duration of the session.