Introduction

In an IBM Cloud® enterprise, the billing unit manages all billing-related objects. With the Enterprise Billing Unit API, you can manage billing units, billing options, and credit pools for an enterprise. For more information about enterprise billing, see Centrally managing billing and usage with enterprises.

SDKs for Java, Node, Python, and Go are available to make it easier to programmatically access the API from your code. The client libraries that are provided by the SDKs implement best practices for using the API and reduce the amount of code that you need to write. The tab for each language includes code examples that demonstrate how to use the client libraries. For more information about using the SDKs, see the IBM Cloud SDK Common project on GitHub.

Installing the Java SDK

Maven

<dependency>
	<groupId>com.ibm.cloud</groupId>
	<artifactId>enterprise-billing-units</artifactId>
	<version>{version}</version>
</dependency>

Gradle

compile 'com.ibm.cloud:enterprise-billing-units:{version}'

Replace {version} in these examples with the release version.

View on GitHub

https://github.com/IBM/platform-services-java-sdk

Installing the Node SDK

npm install ibm-platform-services

View on GitHub

https://github.com/IBM/platform-services-node-sdk

Installing the Python SDK

pip

pip install --upgrade "ibm-platform-services"

View on GitHub

https://github.com/IBM/platform-services-python-sdk

Installing the Go SDK

Go modules (recommended): Add the following import in your code, and then run go build or go mod tidy

import (
	"github.com/IBM/platform-services-go-sdk/enterprisebillingunitsv1"
)

Go get

go get -u github.com/IBM/platform-services-go-sdk/enterprisebillingunitsv1

View on GitHub

https://github.com/IBM/platform-services-go-sdk

Endpoint URLs

The Enterprise Billing Units API uses the following global endpoint URL. When you call the API, add the path for each method to form the complete API endpoint for your requests.

https://billing.cloud.ibm.com

If you enabled service endpoints in your account, you can send API requests over the IBM Cloud private network at the following base endpoint URLs. For more information, see Enabling VRF and service endpoints.

Private endpoint URL for VPC infrastructure: https://private.billing.cloud.ibm.com
Private endpoint URL (Dallas) for classic infrastructure: https://private.us-south.billing.cloud.ibm.com

Example API request

curl --request POST \
--header "content-type: application/json" \
--header "accept: application/json" \
--header "authorization: Bearer <IAM token>" \
--data "{\"query\":\"string\"}" \
--url "https://api.billing.cloud.ibm.com/v1/resources/billing-options

Replace <IAM token> in this example with the value for your particular API call.

Authentication

Authorization to the Enterprise Billing Units API is enforced by using an IBM Cloud Identity and Access Management (IAM) access token. The token is used to determine the actions that a user or service ID has access to when they use the API.

Obtaining an IAM token for an authenticated user or service ID is described in the IAM Identity Services API documentation.

To use the API, add a valid IAM token to the HTTP Authorization request header, for example, -H 'Authorization: Bearer <TOKEN>'.

When you use the SDK, configure an IAM authenticator with the IAM API key. The authenticator automatically obtains the IAM access token for the API key and includes it with each request. You can construct an authenticator in either of two ways:

Programmatically by constructing an IAM authenticator instance and supplying your IAM API key
By defining the API key in external configuration properties and then using the SDK authenticator factory to construct an IAM authenticator that uses the configured IAM API key

In this example of using external configuration properties, an IAM authenticator instance is created with the configured API key, and then the service client is constructed with this authenticator instance and the configured service URL.

For more information, see the Authentication section of the IBM Cloud SDK Common documentation.

To call each method, you'll need to be assigned a role that includes the required IAM actions. Each method lists the associated action. For more information about IAM actions and how they map to roles, see Assigning access to account management services.

To retrieve your access token:

curl -X POST \
  "https://iam.cloud.ibm.com/identity/token" \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'Accept: application/json' \
  --data-urlencode 'grant_type=urn:ibm:params:oauth:grant-type:apikey' \
  --data-urlencode 'apikey=<API_KEY>'

Replace <API_KEY> with your IAM API key.

Setting client options through external configuration

Example environment variables, where <SERVICE_URL> is the endpoint URL and <API_KEY> is your IAM API key

export ENTERPRISE_BILLING_UNITS_URL=<SERVICE_URL>
export ENTERPRISE_BILLING_UNITS_AUTHTYPE=iam
export ENTERPRISE_BILLING_UNITS_APIKEY=<API_KEY>

Example of constructing the service client

import {
    "github.com/IBM/platform-services-go-sdk/enterprisebillingunitsv1"
}
...
serviceClientOptions := &enterprisebillingunitsv1.EnterpriseBillingUnitsV1Options{}
serviceClient, err := enterprisebillingunitsv1.NewEnterpriseBillingUnitsV1UsingExternalConfig(serviceClientOptions)

Setting client options through external configuration

Example environment variables, where <SERVICE_URL> is the endpoint URL and <API_KEY> is your IAM API key

export ENTERPRISE_BILLING_UNITS_URL=<SERVICE_URL>
export ENTERPRISE_BILLING_UNITS_AUTHTYPE=iam
export ENTERPRISE_BILLING_UNITS_APIKEY=<API_KEY>

Example of constructing the service client

import com.ibm.cloud.platform_services.enterprise_billing_units.v1.EnterpriseBillingUnits;
...
EnterpriseBillingUnits serviceClient = EnterpriseBillingUnits.newInstance();

Setting client options through external configuration

Example environment variables, where <SERVICE_URL> is the endpoint URL and <API_KEY> is your IAM API key

export ENTERPRISE_BILLING_UNITS_URL=<SERVICE_URL>
export ENTERPRISE_BILLING_UNITS_AUTHTYPE=iam
export ENTERPRISE_BILLING_UNITS_APIKEY=<API_KEY>

Example of constructing the service client

const EnterpriseBillingUnitsV1 = require('ibm-platform-services/enterprise-billing-units/v1');
...
const serviceClient = EnterpriseBillingUnitsV1.newInstance();

Setting client options through external configuration

Example environment variables, where <SERVICE_URL> is the endpoint URL and <API_KEY> is your IAM API key

export ENTERPRISE_BILLING_UNITS_URL=<SERVICE_URL>
export ENTERPRISE_BILLING_UNITS_AUTHTYPE=iam
export ENTERPRISE_BILLING_UNITS_APIKEY=<API_KEY>

Example of constructing the service client

from ibm_platform_services import EnterpriseBillingUnitsV1
...
service_client = EnterpriseBillingUnitsV1.new_instance()

Error handling

The resource manager uses standard HTTP response codes to indicate whether a method completed successfully. A 200 type response always indicates success. A 400 type response is a failure, and a 500 type response is an internal system error.

| HTTP Code | Description | Recovery | |:----------|:----------------------|:---------------------------------------------------------------------------------------------------------------------------------------| | 200 | Success | The request was successful. | | 400 | Bad Request | The input parameters in the request are either incomplete or in the wrong format. Be sure to include all the required parameters in your request. Be sure to validate your request. | | 401 | Authentication Failed | You are not authorized to make this request, or the token that is provided in the Authorization header is invalid or expired. Verify that the token is correct. Log in to IBM Cloud and try again. If this error persists, contact the account owner to check your permissions. | | 403 | Authorization Failed | The supplied authentication is not authorized to access '{namespace}'. | | 404 | Not Found | The required resource was not found. | | 412 | Precondition Failed | The server failed to resolve account ID by request header fields. | | 424 | Dependency Failure | The dependencies for the entity are not set up correctly. The dependencies must be correct before a report can be generated. | | 5xx | Internal Server Error | offering name is currently unavailable. Your request could not be processed. Wait a few minutes and try again. |

Pagination

Some API requests might return many results. To avoid performance issues, these results are returned one page at a time, with a limited number of results on each page. GET requests for the following resources use pagination:

/v1/billing-units?:query
/v1/billing-options?:query
/v1/credit-pools?:query

The rows_count, next_url and resources fields are included in the collection response. The next_url field gives the link to the next page of results. By default, each page contains 100 items, which is also the maximum number of items per page. To specify a different number of items per page, use the limit query parameter. The rows_count field indicates the number of resources that exist on the page.

Related APIs

See the following related APIs for managing IBM Cloud enterprises:

Enterprise Management API: Create and manage enterprises, account groups, and accounts.
Enterprise Usage Reports API: Get usage reports for an enterprise, account group, or account.

Enterprise Billing Units | IBM Cloud API Docs