Create a grant.

curl --request POST \
  --url https://api.example.com/v2/grants \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "account_id": "account_0194f4e3a2b77c6aa91c4f6b4db2a980",
  "metric_id": "metric_0194f4e3a2b77c6aa91c4f6b4db2a980",
  "amount": "100.0",
  "effective_at": 1767225600,
  "description": "Usage tracked for Acme.",
  "currency": "usd",
  "expires_at": 1767225600,
  "contract_v1_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.example.com/v2/grants"

payload = {
    "account_id": "account_0194f4e3a2b77c6aa91c4f6b4db2a980",
    "metric_id": "metric_0194f4e3a2b77c6aa91c4f6b4db2a980",
    "amount": "100.0",
    "effective_at": 1767225600,
    "description": "Usage tracked for Acme.",
    "currency": "usd",
    "expires_at": 1767225600,
    "contract_v1_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    account_id: 'account_0194f4e3a2b77c6aa91c4f6b4db2a980',
    metric_id: 'metric_0194f4e3a2b77c6aa91c4f6b4db2a980',
    amount: '100.0',
    effective_at: 1767225600,
    description: 'Usage tracked for Acme.',
    currency: 'usd',
    expires_at: 1767225600,
    contract_v1_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.example.com/v2/grants', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v2/grants",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account_id' => 'account_0194f4e3a2b77c6aa91c4f6b4db2a980',
    'metric_id' => 'metric_0194f4e3a2b77c6aa91c4f6b4db2a980',
    'amount' => '100.0',
    'effective_at' => 1767225600,
    'description' => 'Usage tracked for Acme.',
    'currency' => 'usd',
    'expires_at' => 1767225600,
    'contract_v1_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.example.com/v2/grants"

	payload := strings.NewReader("{\n  \"account_id\": \"account_0194f4e3a2b77c6aa91c4f6b4db2a980\",\n  \"metric_id\": \"metric_0194f4e3a2b77c6aa91c4f6b4db2a980\",\n  \"amount\": \"100.0\",\n  \"effective_at\": 1767225600,\n  \"description\": \"Usage tracked for Acme.\",\n  \"currency\": \"usd\",\n  \"expires_at\": 1767225600,\n  \"contract_v1_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v2/grants")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"account_0194f4e3a2b77c6aa91c4f6b4db2a980\",\n  \"metric_id\": \"metric_0194f4e3a2b77c6aa91c4f6b4db2a980\",\n  \"amount\": \"100.0\",\n  \"effective_at\": 1767225600,\n  \"description\": \"Usage tracked for Acme.\",\n  \"currency\": \"usd\",\n  \"expires_at\": 1767225600,\n  \"contract_v1_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/grants")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": \"account_0194f4e3a2b77c6aa91c4f6b4db2a980\",\n  \"metric_id\": \"metric_0194f4e3a2b77c6aa91c4f6b4db2a980\",\n  \"amount\": \"100.0\",\n  \"effective_at\": 1767225600,\n  \"description\": \"Usage tracked for Acme.\",\n  \"currency\": \"usd\",\n  \"expires_at\": 1767225600,\n  \"contract_v1_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "id": "grant_0194f4e3a2b77c6aa91c4f6b4db2a980",
  "description": "Usage tracked for Acme.",
  "account_id": "account_0194f4e3a2b77c6aa91c4f6b4db2a980",
  "metric_id": "metric_0194f4e3a2b77c6aa91c4f6b4db2a980",
  "currency": "usd",
  "amount": "100.0",
  "expires_at": 1767225600,
  "accepted_at": 1767225600,
  "created_at": 1767225600,
  "updated_at": 1767225600,
  "status": "active",
  "archived_at": 1767225600,
  "contract_v1_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "effective_at": 1767225600
}

"<string>"

"Invalid API key"

"<string>"

"<string>"

"<string>"

"<string>"

"<string>"

"<string>"

"rate limit exceeded"

"<string>"

POST

grants

Create a grant.

curl --request POST \
  --url https://api.example.com/v2/grants \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "account_id": "account_0194f4e3a2b77c6aa91c4f6b4db2a980",
  "metric_id": "metric_0194f4e3a2b77c6aa91c4f6b4db2a980",
  "amount": "100.0",
  "effective_at": 1767225600,
  "description": "Usage tracked for Acme.",
  "currency": "usd",
  "expires_at": 1767225600,
  "contract_v1_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.example.com/v2/grants"

payload = {
    "account_id": "account_0194f4e3a2b77c6aa91c4f6b4db2a980",
    "metric_id": "metric_0194f4e3a2b77c6aa91c4f6b4db2a980",
    "amount": "100.0",
    "effective_at": 1767225600,
    "description": "Usage tracked for Acme.",
    "currency": "usd",
    "expires_at": 1767225600,
    "contract_v1_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    account_id: 'account_0194f4e3a2b77c6aa91c4f6b4db2a980',
    metric_id: 'metric_0194f4e3a2b77c6aa91c4f6b4db2a980',
    amount: '100.0',
    effective_at: 1767225600,
    description: 'Usage tracked for Acme.',
    currency: 'usd',
    expires_at: 1767225600,
    contract_v1_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.example.com/v2/grants', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v2/grants",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account_id' => 'account_0194f4e3a2b77c6aa91c4f6b4db2a980',
    'metric_id' => 'metric_0194f4e3a2b77c6aa91c4f6b4db2a980',
    'amount' => '100.0',
    'effective_at' => 1767225600,
    'description' => 'Usage tracked for Acme.',
    'currency' => 'usd',
    'expires_at' => 1767225600,
    'contract_v1_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.example.com/v2/grants"

	payload := strings.NewReader("{\n  \"account_id\": \"account_0194f4e3a2b77c6aa91c4f6b4db2a980\",\n  \"metric_id\": \"metric_0194f4e3a2b77c6aa91c4f6b4db2a980\",\n  \"amount\": \"100.0\",\n  \"effective_at\": 1767225600,\n  \"description\": \"Usage tracked for Acme.\",\n  \"currency\": \"usd\",\n  \"expires_at\": 1767225600,\n  \"contract_v1_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v2/grants")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"account_0194f4e3a2b77c6aa91c4f6b4db2a980\",\n  \"metric_id\": \"metric_0194f4e3a2b77c6aa91c4f6b4db2a980\",\n  \"amount\": \"100.0\",\n  \"effective_at\": 1767225600,\n  \"description\": \"Usage tracked for Acme.\",\n  \"currency\": \"usd\",\n  \"expires_at\": 1767225600,\n  \"contract_v1_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/grants")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": \"account_0194f4e3a2b77c6aa91c4f6b4db2a980\",\n  \"metric_id\": \"metric_0194f4e3a2b77c6aa91c4f6b4db2a980\",\n  \"amount\": \"100.0\",\n  \"effective_at\": 1767225600,\n  \"description\": \"Usage tracked for Acme.\",\n  \"currency\": \"usd\",\n  \"expires_at\": 1767225600,\n  \"contract_v1_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "id": "grant_0194f4e3a2b77c6aa91c4f6b4db2a980",
  "description": "Usage tracked for Acme.",
  "account_id": "account_0194f4e3a2b77c6aa91c4f6b4db2a980",
  "metric_id": "metric_0194f4e3a2b77c6aa91c4f6b4db2a980",
  "currency": "usd",
  "amount": "100.0",
  "expires_at": 1767225600,
  "accepted_at": 1767225600,
  "created_at": 1767225600,
  "updated_at": 1767225600,
  "status": "active",
  "archived_at": 1767225600,
  "contract_v1_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "effective_at": 1767225600
}

"<string>"

"Invalid API key"

"<string>"

"<string>"

"<string>"

"<string>"

"<string>"

"<string>"

"rate limit exceeded"

"<string>"

Authorizations

x-api-key

string

header

required

LedgerUp API Key.

Headers

Idempotency-Key

string

Optional. Duplicate keys within the same company namespace and route return 409. Non-empty idempotency key for deduplicating write requests on the same route.

Example:

"6f31c20e-725c-4be8-96f4-835042f67602"

Body

application/json

Option 1
Option 2

Create-grant request. Exactly one of metric_id or currency is required. Unknown JSON fields are rejected. When provided, expires_at must be after effective_at.

account_id

string

required

LedgerUp account identifier.

Pattern: ^account_[0-9a-f]{32}$

Example:

"account_0194f4e3a2b77c6aa91c4f6b4db2a980"

metric_id

string

required

LedgerUp metric identifier. Required when currency is omitted.

Pattern: ^metric_[0-9a-f]{32}$

Example:

"metric_0194f4e3a2b77c6aa91c4f6b4db2a980"

amount

string

required

Decimal amount as a string.

Pattern: ^-?\d+(\.\d+)?$

Example:

"100.0"

effective_at

integer<int64>

required

Unix timestamp in seconds.

Example:

1767225600

description

string | null

Optional description. Maximum 2048 Unicode scalar values.

Maximum string length: 2048

Example:

"Usage tracked for Acme."

currency

string

Three-letter ISO 4217-style currency code. Amount is expressed in major currency units, not minor units. Required when metric_id is omitted. Stored lowercase; metric_id remains null.

Pattern: ^[A-Za-z]{3}$

Example:

"usd"

expires_at

integer<int64> | null

Unix timestamp in seconds.

Example:

1767225600

contract_v1_id

string<uuid> | null

Optional public.contracts identifier.

Response

Created.

string

required

LedgerUp grant identifier.

Pattern: ^grant_[0-9a-f]{32}$

Example:

"grant_0194f4e3a2b77c6aa91c4f6b4db2a980"

description

string | null

required

Optional description. Maximum 2048 Unicode scalar values.

Maximum string length: 2048

Example:

"Usage tracked for Acme."

account_id

string

required

LedgerUp account identifier.

Pattern: ^account_[0-9a-f]{32}$

Example:

"account_0194f4e3a2b77c6aa91c4f6b4db2a980"

metric_id

string | null

required

LedgerUp metric identifier. Null for currency grants.

Pattern: ^metric_[0-9a-f]{32}$

Example:

"metric_0194f4e3a2b77c6aa91c4f6b4db2a980"

currency

string | null

required

Three-letter lowercase currency code. Amount is expressed in major currency units, not minor units. Null for metric grants.

Pattern: ^[a-z]{3}$

Example:

"usd"

amount

string

required

Decimal amount serialized as a string.

Pattern: ^-?\d+(\.\d+)?$

Example:

"100.0"

expires_at

integer<int64> | null

required

Unix timestamp in seconds.

Example:

1767225600

accepted_at

integer<int64>

required

Unix timestamp in seconds.

Example:

1767225600

created_at

integer<int64>

required

Unix timestamp in seconds.

Example:

1767225600

updated_at

integer<int64>

required

Unix timestamp in seconds.

Example:

1767225600

status

enum<string>

required

Derived grant status. Voided and archived take precedence over expiration and scheduled activation.

Available options:

active,

scheduled,

voided,

archived,

expired

Example:

"active"

archived_at

integer<int64> | null

required

Unix timestamp in seconds.

Example:

1767225600

contract_v1_id

string<uuid> | null

required

Optional public.contracts identifier.

effective_at

integer<int64>

required

Unix timestamp in seconds.

Example:

1767225600

API Reference

Webhooks

Create a grant.

Authorizations

Headers

Body

Response