--- title: Billing Account API - Notehub API Reference description: The Notehub Billing Account API is deprecated. Use the Notehub Organization API instead, which provides RESTful methods to GET data related to Notehub organizations. source_url: https://dev.blues.io/api-reference/notehub-api/billing-account-api/ canonical_url: https://dev.blues.io/api-reference/notehub-api/billing-account-api/ markdown_url: https://dev.blues.io/api-reference/notehub-api/billing-account-api.md --- # Billing Account API (Deprecated) The Notehub billing account API provides RESTful methods that can be used to retrieve data related to Notehub billing accounts. > **Deprecated:** > > The Billing Account API is deprecated. Use the [Organization API](https://dev.blues.io/api-reference/notehub-api/organization-api.md) instead, which provides the same data for Notehub organizations. | Name | HTTP Request | | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | | [Get Billing Accounts](#get-billing-accounts) (Deprecated) | **GET** `/v1/billing-accounts` | | [Get Billing Account](#get-billing-account) (Deprecated) | **GET** `/v1/billing-accounts/{billingAccountUID}` | | [Get Billing Account Balance History](#get-billing-account-balance-history) (Deprecated) | **GET** `/v1/billing-accounts/{billingAccountUID}/balance-history` | ## Get Billing Accounts (Notehub) (Deprecated) Get an array of Notehub billing accounts associated with a generated authentication token. > **Deprecated:** > > This request is deprecated. Use the [Get Organizations](https://dev.blues.io/api-reference/notehub-api/organization-api.md#get-organizations) request instead. | | | | ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | HTTP Method: | `GET` | | URL: | `https://api.notefile.net/v1/billing-accounts` | | Minimum Notehub [project-level role:](https://dev.blues.io/notehub/notehub-walkthrough.md#collaborator-roles) | viewer | | Required HTTP Headers: | `Authorization: Bearer `, where the token is a valid [authentication token](https://dev.blues.io/api-reference/notehub-api.md#authentication). | Arguments None **Example** **Bash** ```bash curl -X GET -L 'https://api.notefile.net/v1/billing-accounts' -H 'Authorization: Bearer ' ``` **JS** ```javascript import * as NotehubJs from "@blues-inc/notehub-js"; let defaultClient = NotehubJs.ApiClient.instance; // Configure Bearer access token for authorization: personalAccessToken let personalAccessToken = defaultClient.authentications["personalAccessToken"]; personalAccessToken.accessToken = "YOUR ACCESS TOKEN"; let apiInstance = new NotehubJs.BillingAccountApi(); apiInstance.getBillingAccounts().then( (data) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }, (error) => { console.error(error); } ); ``` **Python** ```python import notehub_py from notehub_py.models.get_billing_accounts200_response import GetBillingAccounts200Response from notehub_py.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://api.notefile.net configuration = notehub_py.Configuration( host = "https://api.notefile.net" ) # Configure Bearer authorization: personalAccessToken configuration = notehub_py.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = notehub_py.BillingAccountApi(api_client) try: api_response = api_instance.get_billing_accounts() print("The response of BillingAccountApi->get_billing_accounts:\n") pprint(api_response) except Exception as e: print("Exception when calling BillingAccountApi->get_billing_accounts: %s\n" % e) ``` **Response Members** ### `uid` *string* The globally-unique identifier of the billing account. ### `name` *string* The name of the billing account. ### `role` The role of the billing account: `billing_admin` Full administrative privileges to purchase credits, setup auto-recharge and invite members. `billing_manager` Access to invite members is restricted. `project_creator` Access is limited to creating projects within a billing account. Example Response ```json { "billing_accounts": [ { "uid": "00000000-0000-0000-0000-000000000000", "name": "Jane's Billing Account", "role": "billing_admin" }, { "uid": "00000000-0000-0000-0000-000000000000", "name": "John's Billing Account", "role": "billing_manager" } ] } ``` ## Get Billing Account (Notehub) (Deprecated) Get information about a single Notehub billing account by its BillingAccountUID. > **Deprecated:** > > This request is deprecated. Use the [Get Organization](https://dev.blues.io/api-reference/notehub-api/organization-api.md#get-organization) request instead. | | | | ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | HTTP Method: | `GET` | | URL: | `https://api.notefile.net/v1/billing-accounts/{billingAccountUID}` | | Path Parameters: | - `billingAccountUID` - The globally-unique identifier of a Notehub billing account. | | Minimum Notehub [project-level role:](https://dev.blues.io/notehub/notehub-walkthrough.md#collaborator-roles) | viewer | | Required HTTP Headers: | `Authorization: Bearer `, where the token is a valid [authentication token](https://dev.blues.io/api-reference/notehub-api.md#authentication). | Arguments None **Example** **Bash** ```bash curl -X GET -L 'https://api.notefile.net/v1/billing-accounts/' -H 'Authorization: Bearer ' ``` **Response Members** ### `uid` *string* The globally-unique identifier of the billing account. ### `name` *string* The name of the billing account. ### `owner` *string* The name of the owner of the billing account. ### `suspended` *boolean* Whether or not the billing account is suspended. ### `plan` *object* An object containing the billing account's current plan information. ### `plan.type` *string* The type of plan associated with this billing account. One of `"Enterprise"` or `"Essentials"`. ### `plan.current_balance` *integer* The event capacity remaining on the plan. ### `plan.start_date` *string (date)* The start date of the current plan period. ### `plan.end_date` *string (date)* For enterprise accounts, the end date of the current plan period. ### `plan.event_capacity` *integer* For enterprise accounts, the total event capacity for the current plan period. Example Response ```json { "uid": "00000000-0000-0000-0000-000000000000", "name": "Jane's Billing Account", "owner": "jane@example.com", "suspended": false, "plan": { "type": "Essentials", "current_balance": 5000, "start_date": "2026-01-01T00:00:00Z" } } ``` ## Get Billing Account Balance History (Notehub) (Deprecated) Get the event balance history for a Notehub billing account. > **Deprecated:** > > This request is deprecated. Use the [Get Organization Balance History](https://dev.blues.io/api-reference/notehub-api/organization-api.md#get-organization-balance-history) request instead. | | | | ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | HTTP Method: | `GET` | | URL: | `https://api.notefile.net/v1/billing-accounts/{billingAccountUID}/balance-history` | | Path Parameters: | - `billingAccountUID` - The globally-unique identifier of a Notehub billing account. | | Minimum Notehub [project-level role:](https://dev.blues.io/notehub/notehub-walkthrough.md#collaborator-roles) | viewer | | Required HTTP Headers: | `Authorization: Bearer `, where the token is a valid [authentication token](https://dev.blues.io/api-reference/notehub-api.md#authentication). | Arguments ### `startDate` *string (optional)* Start date for filtering results, in ISO 8601 date-time format. ### `endDate` *string (optional)* End date for filtering results, in ISO 8601 date-time format. **Example** **Bash** ```bash curl -X GET -L 'https://api.notefile.net/v1/billing-accounts//balance-history' -H 'Authorization: Bearer ' ``` **Response Members** ### `data` *array of objects* An array of objects containing event balance history. Each object contains the following fields: ### `data.period` *string (date)* The start of the time period for this balance record. ### `data.remaining_event_capacity` *integer* The number of events remaining in the billing account's capacity at the end of this period. ### `data.total_event_capacity_used` *integer* The total number of events consumed from the billing account's capacity during this period. Example Response ```json { "data": [ { "period": "2026-01-01T00:00:00Z", "remaining_event_capacity": 15000, "total_event_capacity_used": 5000 }, { "period": "2026-01-02T00:00:00Z", "remaining_event_capacity": 10000, "total_event_capacity_used": 5000 }, { "period": "2026-01-03T00:00:00Z", "remaining_event_capacity": 5000, "total_event_capacity_used": 5000 } ] } ``` [Authorization API](https://dev.blues.io/api-reference/notehub-api/authorization-api.md "Authorization API") [Device API](https://dev.blues.io/api-reference/notehub-api/device-api.md "Device API")