Counter value

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…

You can use this API to query the value that a counter has for an allowance, so you can see the usage data of your customers subscription. You'll need to enter the subscription ID and and the counter ID, which you'll find on the allowances page in the Billsby app.

This is useful if you want to check if your customers have any allowance left on their account before you permit a certain action.

Returned variables

Variable nameDescription
usageCurrent usage for the period
timestampWhen the counter was last updated
Path Params
string
required

Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets

string
required

The unique identifier of the subscription in the Billsby platform

string
required

The unique identifier of the counter in the Billsby platform

Query Params
date

The date you would like the counter value from; format is ISO 8601, e.g. 2020-08-25T18:35:00.000Z

date

The date you would like the counter value to; format is ISO 8601, e.g. 2020-08-25T18:35:00.000Z

Response

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json