Billing
Get billing status
Return the organization plan, renewal date, and whether usage-based billing is enabled.
/billing/orgUse this to get your organization plan, subscription status, and renewal time.
For payment method, upcoming charge, and the subscription list, use Get billing overview. For allowance and whether one instance is blocked, use Get record counts.
Enterprise authentication
Send these requests to https://api.cloud.blnkfinance.com on Blnk Cloud. On a self-hosted Enterprise deployment, send them to ENTERPRISE_PUBLIC_URL.
Pass an Enterprise API key, or an OAuth access token, in the X-blnk-key header. Create the key in Enterprise API keys, or issue a token with Enterprise OAuth.
This credential comes from the Cloud or Enterprise workspace. A Core API key belongs to the Core instance.
X-blnk-keystring
Enterprise API key, or an OAuth access token.
Response
billing_idstring
Unique identifier for the organization billing record (bil_...).
billing_emailstring
Email on the billing account.
planstring
Organization plan code, such as PRODUCTION_MONTHLY.
created_attimestamp
When the organization billing record was created. ISO 8601.
statusstring
Organization subscription status, such as ACTIVE.
last_updatetimestamp
When the billing record was last updated. ISO 8601.
next_renewaltimestamp
When the current plan renews. ISO 8601. Overview uses a Unix next_billing_date for the next charge.
has_billing_historyboolean
Whether the organization has past invoices or charges.
usage_billing_enabledboolean
Whether usage-based billing is on for the organization. See Usage-based billing.
usage_billing_enabled_attimestamp
When usage-based billing was enabled for the organization. ISO 8601.