Skip to main content
GET
Get usage summary

Authorizations

Authorization
string
header
required

Your PayBridgeNP API key. Obtain one from the dashboard under Settings → API Keys. Prefix: sk_test_ for testing, sk_live_ for production.

Path Parameters

id
string
required

Response

Usage summary.

object
enum<string>
Available options:
usage_summary
subscription_id
string
period_start
string<date-time> | null
period_end
string<date-time> | null
quantity
integer

Aggregated usage for the current period.

aggregation_method
enum<string>
Available options:
sum,
max,
last_ever
record_count
integer