Get a credit grant

curl --request GET \
  --url https://eu.sequencehq.com/api/credit-grants/{id} \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://eu.sequencehq.com/api/credit-grants/{id}', 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://eu.sequencehq.com/api/credit-grants/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://eu.sequencehq.com/api/credit-grants/{id}"

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

	req.Header.Add("Authorization", "<authorization>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://eu.sequencehq.com/api/credit-grants/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

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

{
  "id": "0199ca8a-e7e8-73b3-bd69-a316a23231a0",
  "sequenceAccountId": "dce9ae85-d8d0-42b4-bcad-f221a64363c6",
  "customerId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
  "scope": "SCHEDULE",
  "billingScheduleId": "0199ca86-560e-7ac4-999f-bee364f7e4e7",
  "phaseId": "0199ca87-6d80-7836-aa09-10386a08d761",
  "name": "Monthly usage credits",
  "creditUnitType": "CURRENCY",
  "currency": "GBP",
  "metricId": "f092246c-6b90-4106-bcca-304ccf06bf45",
  "amount": 100,
  "availableBalance": 79.35,
  "state": {
    "issuance": "ISSUED",
    "validity": "CURRENT"
  },
  "costOfCredit": 100,
  "taxRateId": "179d1ab3-cc96-48e2-9310-067b0b42d47c",
  "effectiveDate": "2026-01-01",
  "expiryDate": "2026-01-31",
  "createdAt": "2026-01-01T10:00:00Z",
  "updatedAt": "2026-01-01T10:00:00Z",
  "grantRefreshFrequency": "MONTHLY",
  "billingFrequency": "MONTHLY",
  "rolloverMode": "NONE",
  "sourceGrantId": "0199ca8a-e7e8-73b3-bd69-a316a2323100",
  "restrictToPrices": [
    "0199ca89-2d9e-7e3d-914c-7de86e8fc7ce"
  ],
  "integrationIds": [
    {
      "service": "Xero",
      "id": "74ed2615-4730-49ab-9445-74f31723a206",
      "isPending": false
    }
  ]
}

This response has no body data.

This response has no body data.

This response has no body data.

GET

credit-grants

{id}

Get a credit grant

curl --request GET \
  --url https://eu.sequencehq.com/api/credit-grants/{id} \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://eu.sequencehq.com/api/credit-grants/{id}', 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://eu.sequencehq.com/api/credit-grants/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://eu.sequencehq.com/api/credit-grants/{id}"

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

	req.Header.Add("Authorization", "<authorization>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://eu.sequencehq.com/api/credit-grants/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

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

{
  "id": "0199ca8a-e7e8-73b3-bd69-a316a23231a0",
  "sequenceAccountId": "dce9ae85-d8d0-42b4-bcad-f221a64363c6",
  "customerId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
  "scope": "SCHEDULE",
  "billingScheduleId": "0199ca86-560e-7ac4-999f-bee364f7e4e7",
  "phaseId": "0199ca87-6d80-7836-aa09-10386a08d761",
  "name": "Monthly usage credits",
  "creditUnitType": "CURRENCY",
  "currency": "GBP",
  "metricId": "f092246c-6b90-4106-bcca-304ccf06bf45",
  "amount": 100,
  "availableBalance": 79.35,
  "state": {
    "issuance": "ISSUED",
    "validity": "CURRENT"
  },
  "costOfCredit": 100,
  "taxRateId": "179d1ab3-cc96-48e2-9310-067b0b42d47c",
  "effectiveDate": "2026-01-01",
  "expiryDate": "2026-01-31",
  "createdAt": "2026-01-01T10:00:00Z",
  "updatedAt": "2026-01-01T10:00:00Z",
  "grantRefreshFrequency": "MONTHLY",
  "billingFrequency": "MONTHLY",
  "rolloverMode": "NONE",
  "sourceGrantId": "0199ca8a-e7e8-73b3-bd69-a316a2323100",
  "restrictToPrices": [
    "0199ca89-2d9e-7e3d-914c-7de86e8fc7ce"
  ],
  "integrationIds": [
    {
      "service": "Xero",
      "id": "74ed2615-4730-49ab-9445-74f31723a206",
      "isPending": false
    }
  ]
}

This response has no body data.

This response has no body data.

This response has no body data.

Headers

Authorization

string

required

Your API credentials. Eg. Basic {credentials}.

sequence-version

enum<string>

Use this header to select an API version

Available options:

2024-07-30

Path Parameters

string

required

Credit grant ID

Response

string

required

Credit grant ID.

Example:

"0199ca8a-e7e8-73b3-bd69-a316a23231a0"

sequenceAccountId

string

required

Sequence account ID.

Example:

"dce9ae85-d8d0-42b4-bcad-f221a64363c6"

customerId

string

required

ID of the customer receiving the credit.

Example:

"61b083e0-1faa-47ca-9aeb-6205da8f6c47"

scope

enum<string>

required

Whether the grant is held by the customer directly (CUSTOMER) or belongs to one of their billing schedules (SCHEDULE).

Available options:

CUSTOMER,

SCHEDULE

Example:

"SCHEDULE"

name

string

required

Name of the credit grant.

Example:

"Monthly usage credits"

creditUnitType

enum<string>

required

Whether credit is measured in currency or usage-metric units.

Available options:

CURRENCY,

METRIC

Example:

"CURRENCY"

amount

number

required

The configured credit allowance. Available credit may exceed this amount after rollover. The difference between this amount and available credit does not represent usage.

Example:

100

availableBalance

number

required

Credit currently available for eligible prices. Never negative. Zero before the effective date, while awaiting issuance, when no credit remains, or after expiry. Usage awaiting processing is not yet deducted. Dates are evaluated in UTC and are inclusive.

Example:

79.35

state

object

required

Independent issuance and date-validity states. availableBalance reports the credit usable now.

Show child attributes

Example:

{
  "issuance": "ISSUED",
  "validity": "CURRENT"
}

createdAt

string

required

When the credit grant was created.

Example:

"2026-01-01T10:00:00Z"

updatedAt

string

required

When the grant's configuration last changed. Changes to the available balance do not update this timestamp.

Example:

"2026-01-01T10:00:00Z"

grantRefreshFrequency

enum<string>

required

How often the credit grant refreshes its balance.

Available options:

NONE,

MONTHLY,

QUARTERLY,

HALF_YEARLY,

YEARLY

Example:

"MONTHLY"

billingFrequency

enum<string>

required

How often the customer is charged for the credit grant.

Available options:

ONE_TIME,

MONTHLY,

QUARTERLY,

HALF_YEARLY,

YEARLY

Example:

"MONTHLY"

rolloverMode

enum<string>

required

Whether unused balance carries over when the grant refreshes.

Available options:

NONE,

ON_GRANT_REFRESH,

ON_GRANT_REFRESH_AND_PHASE

Example:

"NONE"

restrictToPrices

string[]

required

IDs of prices eligible to use this credit. Includes all prices in the phase when no restriction was specified. Empty for a customer grant.

Example:

["0199ca89-2d9e-7e3d-914c-7de86e8fc7ce"]

integrationIds

object[]

required

Identifiers for this credit grant in external integrations.

Show child attributes

Example:

[
  {
    "service": "Xero",
    "id": "74ed2615-4730-49ab-9445-74f31723a206",
    "isPending": false
  }
]

billingScheduleId

string | null

ID of the billing schedule the grant belongs to. Absent for a customer grant.

Example:

"0199ca86-560e-7ac4-999f-bee364f7e4e7"

phaseId

string | null

ID of the billing schedule phase the grant belongs to. Absent for a customer grant.

Example:

"0199ca87-6d80-7836-aa09-10386a08d761"

currency

enum<string> | null

Currency the grant is denominated in. Null when creditUnitType is METRIC.

Available options:

AED,

ARS,

AUD,

BRL,

BGN,

CAD,

CHF,

CLP,

CNY,

COP,

CZK,

DKK,

EGP,

EUR,

GBP,

HKD,

ILS,

INR,

ISK,

JPY,

KRW,

MXN,

NOK,

NZD,

PLN,

SAR,

SEK,

SGD,

THB,

USD,

UYU,

ZAR

Example:

"GBP"

metricId

string | null

ID of the usage metric the credit is measured in when creditUnitType is METRIC.

Example:

"f092246c-6b90-4106-bcca-304ccf06bf45"

costOfCredit

number | null

The amount charged to the customer for the credit grant.

Example:

100

taxRateId

string | null

Tax rate ID for the credit grant.

Example:

"179d1ab3-cc96-48e2-9310-067b0b42d47c"

effectiveDate

string | null

First day the credit can be used, inclusive, in UTC.

Example:

"2026-01-01"

expiryDate

string | null

Last day the credit can be used, inclusive, in UTC.

Example:

"2026-01-31"

sourceGrantId

string | null

ID of the grant whose unused credit was rolled over into this grant.

Example:

"0199ca8a-e7e8-73b3-bd69-a316a2323100"

API Reference

Latest Live API

Version 2024-07-30

Get a credit grant

Headers

Path Parameters

Response