Skip to main content
GET
Use 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.

Authorization

Blnk Cloud APIs support any one of the following authentication methods. All of them work with your CLOUD_API_KEY or OAUTH_ACCESS_TOKEN. Pass X-blnk-key: CLOUD_API_KEY or X-blnk-key: OAUTH_ACCESS_TOKEN.
string
required
Cloud API key or OAuth access token. Create credentials in API keys or OAuth.

Response

string
Unique identifier for the organization billing record (bil_...).
string
Email on the billing account.
string
Organization plan code, such as PRODUCTION_MONTHLY.
timestamp
When the organization billing record was created. ISO 8601.
string
Organization subscription status, such as ACTIVE.
timestamp
When the billing record was last updated. ISO 8601.
timestamp
When the current plan renews. ISO 8601. Overview uses a Unix next_billing_date for the next charge.
boolean
Whether the organization has past invoices or charges.
boolean
Whether usage-based billing is on for the organization. See Usage-based billing.
timestamp
When usage-based billing was enabled for the organization. ISO 8601.

Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.