Refunds

List all active refunds

List refunds

Query Parameters

Name, Type	Description
instance Required string	Instance to get refunds for

HTTP Response Status Codes

Status code	Description
200
401	Unauthorized
403	Forbidden
500	Internal server error

Code samples

GET

/refunds

curl -X GET \
  https://api.quantum-computing.ibm.com/runtime/refunds \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Accept: application/json'

import requests
 
response = requests.request(
    "GET",
    "https://api.quantum-computing.ibm.com/runtime/refunds",
    headers={
        "Accept": "application/json",
        "Authorization": "Bearer YOUR_API_TOKEN_HERE"
    },
)
print(response.json())

Responses

Status code

{
  "refunds": [
    {
      "id": 123,
      "createdAt": "2024-01-01T00:00:00Z",
      "refundTime": 450,
      "incidentOccurredAt": "2024-01-01T00:00:00Z",
      "expiresAt": "2024-01-01T00:00:00Z",
      "reason": "There was a hardware problem and some jobs failed",
      "instance": "hub/group/project"
    }
  ]
}

Status code

{
  "type": "object",
  "properties": {
    "refunds": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "example": 123,
            "description": "Refund id"
          },
          "createdAt": {
            "format": "date-time",
            "type": "string",
            "example": "2024-01-01T00:00:00Z",
            "description": "Date when the refund was created"
          },
          "refundTime": {
            "type": "number",
            "example": 450,
            "description": "Time to refund (in seconds)"
          },
          "incidentOccurredAt": {
            "format": "date-time",
            "type": "string",
            "example": "2024-01-01T00:00:00Z",
            "description": "Date the incident happened"
          },
          "expiresAt": {
            "format": "date-time",
            "type": "string",
            "example": "2024-01-01T00:00:00Z",
            "description": "Date the refund will expires"
          },
          "reason": {
            "type": "string",
            "example": "There was a hardware problem and some jobs failed",
            "description": "The reason of the refund"
          },
          "instance": {
            "type": "string",
            "example": "hub/group/project",
            "description": "The instance were the refund will be applied"
          }
        },
        "required": [
          "id",
          "createdAt",
          "refundTime",
          "incidentOccurredAt",
          "expiresAt",
          "reason",
          "instance"
        ]
      }
    }
  },
  "required": [
    "refunds"
  ]
}