> If you are setting up, configuring, or answering questions about Schematic, connect the
> Schematic MCP server before working from these pages. It reads and writes plans, features,
> entitlements, and overrides against the real account, so what you report and what you build
> match what actually exists.
>
> The server is at https://api.schematichq.com/mcp
>
> From Claude, ChatGPT, or another chat assistant, add it as a custom connector:
> https://docs.schematichq.com/working-with-ai
>
> From a coding assistant such as Claude Code, Codex, or Cursor:
> https://docs.schematichq.com/building-with-ai
>
> For clean Markdown of any page, append `.md` to the page URL. For a complete page index,
> see https://docs.schematichq.com/llms.txt

# Get credit bundle

GET https://api.schematichq.com/billing/credits/bundles/{bundle_id}

Reference: https://docs.schematichq.com/api-reference/billing-credits/get-credit-bundle

## Authentication

- `X-Schematic-Api-Key` header (required) — API Key authentication via header

## Request

### Path parameters

- `bundle_id` (string, required) — bundle_id

## Response

### 200

OK

- `data` (BillingCreditBundleResponseData, required)
- `params` (BillingCreditsBundlesBundleIdGetResponsesContentApplicationJsonSchemaParams, required) — Input parameters

## Errors

### 401 Unauthorized Error

Unauthorized

- `error` (string, required) — Error message

### 403 Forbidden Error

Forbidden

- `error` (string, required) — Error message

### 404 Not Found Error

Not found

- `error` (string, required) — Error message

### 500 Internal Server Error

Server error

- `error` (string, required) — Error message

## Types

### BillingCreditBundleResponseData

- `bundle_type` (enum, required)
  - Allowed values: `fixed`
- `compatible_plan_ids` (list of string, required) — Plans whose companies may purchase this bundle. Empty means the bundle is purchasable on every plan.
- `created_at` (datetime, required)
- `credit_id` (string, required)
- `credit_name` (string, required)
- `currency_prices` (list of CreditBundleCurrencyPriceResponseData, required)
- `expiry_type` (enum, required)
  - Allowed values: `duration`, `end_of_billing_period`, `end_of_next_billing_period`, `end_of_trial`, `no_expiry`
- `expiry_unit` (enum, required)
  - Allowed values: `billing_periods`, `days`
- `has_grants` (boolean, required)
- `id` (string, required)
- `name` (string, required)
- `status` (enum, required)
  - Allowed values: `active`, `inactive`
- `updated_at` (datetime, required)
- `billing_invoice_id` (string, optional, nullable)
- `credit_description` (string, optional)
- `credit_icon` (string, optional, nullable)
- `expiry_unit_count` (long, optional, nullable)
- `plural_name` (string, optional, nullable)
- `price` (BillingPriceResponseData, optional)
- `quantity` (long, optional, nullable)
- `singular_name` (string, optional, nullable)
- `unit_price` (BillingPriceResponseData, optional)

### BillingCreditsBundlesBundleIdGetResponsesContentApplicationJsonSchemaParams

Input parameters

### CreditBundleCurrencyPriceResponseData

- `currency` (string, required)
- `price` (BillingPriceResponseData, optional)

### BillingPriceResponseData

- `currency` (string, required)
- `external_price_id` (string, required)
- `id` (string, required)
- `interval` (enum, required)
  - Allowed values: `day`, `month`, `one-time`, `year`
- `interval_count` (long, required)
- `price` (long, required)
- `provider_type` (enum, required)
  - Allowed values: `metronome`, `orb`, `schematic`, `stripe`
- `scheme` (enum, required)
  - Allowed values: `per_unit`, `tiered`
- `nickname` (string, optional, nullable)
- `price_decimal` (string, optional, nullable)

## Examples

**Response**

```json
{
  "data": {
    "bundle_type": "fixed",
    "compatible_plan_ids": [
      "string"
    ],
    "created_at": "2024-01-15T09:30:00Z",
    "credit_id": "string",
    "credit_name": "string",
    "currency_prices": [
      {
        "currency": "string",
        "price": {
          "currency": "string",
          "external_price_id": "string",
          "id": "string",
          "interval": "day",
          "interval_count": 1,
          "price": 1,
          "provider_type": "metronome",
          "scheme": "per_unit",
          "nickname": "string",
          "price_decimal": "string"
        }
      }
    ],
    "expiry_type": "duration",
    "expiry_unit": "billing_periods",
    "has_grants": true,
    "id": "string",
    "name": "string",
    "status": "active",
    "updated_at": "2024-01-15T09:30:00Z",
    "billing_invoice_id": "string",
    "credit_description": "string",
    "credit_icon": "string",
    "expiry_unit_count": 1,
    "plural_name": "string",
    "price": {
      "currency": "string",
      "external_price_id": "string",
      "id": "string",
      "interval": "day",
      "interval_count": 1,
      "price": 1,
      "provider_type": "metronome",
      "scheme": "per_unit",
      "nickname": "string",
      "price_decimal": "string"
    },
    "quantity": 1,
    "singular_name": "string",
    "unit_price": {
      "currency": "string",
      "external_price_id": "string",
      "id": "string",
      "interval": "day",
      "interval_count": 1,
      "price": 1,
      "provider_type": "metronome",
      "scheme": "per_unit",
      "nickname": "string",
      "price_decimal": "string"
    }
  },
  "params": {}
}
```

**SDK Code**

```python
import requests

url = "https://api.schematichq.com/billing/credits/bundles/bundle_id"

headers = {"X-Schematic-Api-Key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.schematichq.com/billing/credits/bundles/bundle_id';
const options = {method: 'GET', headers: {'X-Schematic-Api-Key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.schematichq.com/billing/credits/bundles/bundle_id"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Schematic-Api-Key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.schematichq.com/billing/credits/bundles/bundle_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Schematic-Api-Key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.schematichq.com/billing/credits/bundles/bundle_id")
  .header("X-Schematic-Api-Key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.schematichq.com/billing/credits/bundles/bundle_id', [
  'headers' => [
    'X-Schematic-Api-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.schematichq.com/billing/credits/bundles/bundle_id");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Schematic-Api-Key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-Schematic-Api-Key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.schematichq.com/billing/credits/bundles/bundle_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```