Get plan usage
get_usageThis calendar month's course views against the plan's allowance, plus what any excess costs at the published rate. Paid plans keep serving past the allowance and bill the excess; the sandbox has no overage rate (null) and stops serving at its limit.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| over | Yes | Views beyond the allowance. Zero when inside it. | |
| plan | Yes | ||
| used | Yes | Billable course views so far this calendar month. | |
| limit | Yes | Views the plan includes each month. | |
| periodEnd | Yes | End of this month's usage period (exclusive), ISO 8601 in UTC. | |
| periodStart | Yes | Start of this month's usage period, ISO 8601 in UTC. | |
| overageCents | Yes | What the extra views cost at the published rate, in cents. | |
| ratePer1kOverage | Yes | Published price in dollars per 1,000 extra views, or null where extra views are not sold. |