Accounts

Get account configuration

Get the current account information. If no account information is found, returns the default configuration.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access

quantum-computing.account-configuration.read

Auditing

Calling this method generates the following auditing events.

quantum-computing.account-configuration.read

Input

Path Parameters
Name, Type	Description
id Required string	Account id (without `a/` prefix)

Query Parameters
Name, Type	Description
plan_id string	Obtain the account configuration only for the specified plan

Code samples

GET

/v1/accounts/{id}

If your instance is in the eu-de region, use this URL instead: https://eu-de.quantum.cloud.ibm.com/api/v1/accounts/{id}

curl -X GET \
  https://quantum.cloud.ibm.com/api/v1/accounts/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Service-CRN: YOUR-SERVICE-CRN' \
  -H 'IBM-API-Version: 2026-02-15'

If your instance is in the eu-de region, use this URL instead: https://eu-de.quantum.cloud.ibm.com/api/v1/accounts/{id}

import requests

response = requests.request(
    "GET",
    "https://quantum.cloud.ibm.com/api/v1/accounts/{id}",
    headers={
      "Accept": "application/json",
      "IBM-API-Version": "2026-02-15",
      "Authorization": "Bearer YOUR-TOKEN",
      "Service-CRN": "YOUR-SERVICE-CRN"
    },
)
print(response.json())

Output

HTTP Response Status Codes
Status code	Description
200	Account configuration successfully retrieved
400	Bad Request
401	Unauthorized
404	Not Found
500	Internal error

Responses

Status code

{
  "plans": [
    {
      "plan_id": "flex-plan-id-1",
      "usage_allocation_seconds": 200,
      "usage_limit_seconds": 200,
      "unallocated_usage_seconds": 200,
      "backends": [
        "ibm_backend"
      ],
      "max_ttl": 28800,
      "active_ttl": 28800,
      "interactive_ttl": 60,
      "start_time": "2025-05-17T00:00:00Z",
      "end_time": "2026-05-17T00:00:00Z"
    },
    {
      "plan_id": "plan-id-2",
      "usage_allocation_seconds": 150,
      "usage_limit_seconds": 300,
      "unallocated_usage_seconds": 10,
      "backends": [
        "backend1",
        "backend2"
      ]
    },
    {
      "plan_id": "plan-id-3",
      "backends": [
        "backend1",
        "backend2"
      ]
    }
  ]
}

{
  "type": "object",
  "description": "Configuration for an account managed by the IBM Qiskit Runtime service.",
  "properties": {
    "plans": {
      "description": "The list of configurations for the account per plan",
      "type": "array",
      "items": {
        "allOf": [
          {
            "properties": {
              "plan_id": {
                "type": "string",
                "description": "The plan id as defined in Global Catalog",
                "pattern": "^.*$",
                "minLength": 1,
                "maxLength": 128
              },
              "usage_allocation_seconds": {
                "type": "integer",
                "format": "int32",
                "minimum": 0,
                "maximum": 2147483647,
                "description": "The maximum sum of allowable usage allocation across all instances in the account."
              },
              "usage_limit_seconds": {
                "type": "integer",
                "format": "int32",
                "minimum": 0,
                "maximum": 2147483647,
                "description": "The maximum amount of time workloads can run accross all instances in the account for the specified plan"
              },
              "backends": {
                "type": "array",
                "description": "List of backends to allow the account to assign for instances.",
                "items": {
                  "type": "string",
                  "pattern": "^.*$",
                  "minLength": 1,
                  "maxLength": 128
                },
                "minItems": 0,
                "maxItems": 100
              },
              "max_ttl": {
                "type": "integer",
                "format": "int32",
                "minimum": 0,
                "maximum": 2147483647,
                "description": "The maximum time (in seconds) for session to run, subject to plan limits."
              },
              "active_ttl": {
                "type": "integer",
                "format": "int32",
                "minimum": 0,
                "maximum": 2147483647,
                "description": "The remaining time (in seconds) for the session to be in the active state while jobs are running. Must be less than or equal to max ttl."
              },
              "interactive_ttl": {
                "type": "integer",
                "format": "int32",
                "minimum": 0,
                "maximum": 2147483647,
                "description": "The maximum time (in seconds) between jobs to keep the session active. Must be less than or equal to active ttl."
              },
              "start_time": {
                "type": "string",
                "format": "date-time",
                "description": "Start time for contract-based plans"
              },
              "end_time": {
                "type": "string",
                "format": "date-time",
                "description": "End time for contract-based plans"
              }
            },
            "required": [
              "backends",
              "plan_id"
            ]
          },
          {
            "type": "object",
            "properties": {
              "unallocated_usage_seconds": {
                "type": "integer",
                "format": "int32",
                "minimum": 0,
                "maximum": 2147483647,
                "description": "The remaining usage allocation that can still be allocated to instances."
              }
            }
          }
        ]
      },
      "minItems": 0,
      "maxItems": 20
    }
  },
  "required": [
    "plans"
  ]
}