> 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

# Update credit

PUT https://api.schematichq.com/billing/credits/{credit_id}
Content-Type: application/json

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

## Authentication

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

## Request

### Path parameters

- `credit_id` (string, required) — credit_id

### Body (application/json)

This endpoint expects an UpdateBillingCreditRequestBody.

- `description` (string, required)
- `name` (string, required)
- `burn_strategy` (enum, optional, nullable)
  - Allowed values: `expiration_priority`, `first_in_first_out`, `last_in_first_out`, `plan_first_then_credit_bundles_first_in_first_out`
- `currency_prices` (list of CreditCurrencyPriceRequestBody, optional, nullable)
- `default_expiry_unit` (enum, optional, nullable)
  - Allowed values: `billing_periods`, `days`
- `default_expiry_unit_count` (long, optional, nullable)
- `default_rollover_policy` (enum, optional, nullable)
  - Allowed values: `expire`, `none`, `rollover`
- `icon` (string, optional, nullable)
- `per_unit_price` (long, optional, nullable)
- `per_unit_price_decimal` (string, optional, nullable)
- `plural_name` (string, optional, nullable)
- `singular_name` (string, optional, nullable)

## Response

### 200

OK

- `data` (BillingCreditResponseData, required)
- `params` (BillingCreditsCreditIdPutResponsesContentApplicationJsonSchemaParams, required) — Input parameters

## Errors

### 400 Bad Request Error

Bad request

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

### 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

### CreditCurrencyPriceRequestBody

- `currency` (string, required)
- `price_per_unit` (long, optional, nullable)
- `price_per_unit_decimal` (string, optional, nullable)

### BillingCreditResponseData

- `burn_strategy` (enum, required)
  - Allowed values: `expiration_priority`, `first_in_first_out`, `last_in_first_out`, `plan_first_then_credit_bundles_first_in_first_out`
- `cost_editable` (boolean, required)
- `created_at` (datetime, required)
- `currency_prices` (list of CreditCurrencyPriceResponseData, required)
- `default_expiry_unit` (enum, required)
  - Allowed values: `billing_periods`, `days`
- `default_rollover_policy` (enum, required)
  - Allowed values: `expire`, `none`, `rollover`
- `description` (string, required)
- `id` (string, required)
- `ledger_authority` (enum, required)
  - Allowed values: `schematic_authoritative`, `external_mirror`, `external_rated`
- `name` (string, required)
- `updated_at` (datetime, required)
- `default_expiry_unit_count` (long, optional, nullable)
- `icon` (string, optional, nullable)
- `plural_name` (string, optional, nullable)
- `price` (BillingPriceResponseData, optional)
- `product` (BillingProductResponseData, optional)
- `singular_name` (string, optional, nullable)

### BillingCreditsCreditIdPutResponsesContentApplicationJsonSchemaParams

Input parameters

### CreditCurrencyPriceResponseData

- `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)

### BillingProductResponseData

- `account_id` (string, required)
- `created_at` (datetime, required)
- `environment_id` (string, required)
- `external_id` (string, required)
- `is_active` (boolean, required)
- `name` (string, required)
- `price` (double, required)
- `product_id` (string, required)
- `provider_type` (enum, required)
  - Allowed values: `metronome`, `orb`, `schematic`, `stripe`
- `quantity` (double, required)
- `updated_at` (datetime, required)
- `price_decimal` (string, optional, nullable)
- `currency` (string, optional, nullable, deprecated) — Deprecated; currencies are associated with prices, not products

## Examples

**Request**

```json
{
  "description": "string",
  "name": "string"
}
```

**Response**

```json
{
  "data": {
    "burn_strategy": "expiration_priority",
    "cost_editable": true,
    "created_at": "2024-01-15T09:30:00Z",
    "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"
        }
      }
    ],
    "default_expiry_unit": "billing_periods",
    "default_rollover_policy": "expire",
    "description": "string",
    "id": "string",
    "ledger_authority": "schematic_authoritative",
    "name": "string",
    "updated_at": "2024-01-15T09:30:00Z",
    "default_expiry_unit_count": 1,
    "icon": "string",
    "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"
    },
    "product": {
      "account_id": "string",
      "created_at": "2024-01-15T09:30:00Z",
      "environment_id": "string",
      "external_id": "string",
      "is_active": true,
      "name": "string",
      "price": 1.1,
      "product_id": "string",
      "provider_type": "metronome",
      "quantity": 1.1,
      "updated_at": "2024-01-15T09:30:00Z",
      "price_decimal": "string",
      "currency": "string"
    },
    "singular_name": "string"
  },
  "params": {}
}
```

**SDK Code**

```python
import requests

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

payload = {
    "description": "string",
    "name": "string"
}
headers = {
    "X-Schematic-Api-Key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.schematichq.com/billing/credits/credit_id';
const options = {
  method: 'PUT',
  headers: {'X-Schematic-Api-Key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"description":"string","name":"string"}'
};

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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"description\": \"string\",\n  \"name\": \"string\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("X-Schematic-Api-Key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	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/credit_id")

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

request = Net::HTTP::Put.new(url)
request["X-Schematic-Api-Key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"string\",\n  \"name\": \"string\"\n}"

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.put("https://api.schematichq.com/billing/credits/credit_id")
  .header("X-Schematic-Api-Key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"string\",\n  \"name\": \"string\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.schematichq.com/billing/credits/credit_id', [
  'body' => '{
  "description": "string",
  "name": "string"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-Schematic-Api-Key' => '<apiKey>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.schematichq.com/billing/credits/credit_id");
var request = new RestRequest(Method.PUT);
request.AddHeader("X-Schematic-Api-Key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"description\": \"string\",\n  \"name\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-Schematic-Api-Key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "description": "string",
  "name": "string"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.schematichq.com/billing/credits/credit_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```