GET
/
credits
/
{id}
Get a credit grant
curl --request GET \
  --url https://eu.sequencehq.com/api/credits/{id} \
  --header 'Authorization: <authorization>'
{
  "id": "746fc7f2-8098-4fe7-953c-7d51c580a126",
  "sequenceAccountId": "dce9ae85-d8d0-42b4-bcad-f221a64363c6",
  "customerId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
  "name": "On-boarding Credits",
  "creditUnitType": "CURRENCY",
  "currency": "GBP",
  "metricId": "f092246c-6b90-4106-bcca-304ccf06bf45",
  "amount": 10,
  "costOfCredit": 10,
  "taxRateId": "179d1ab3-cc96-48e2-9310-067b0b42d47c",
  "effectiveDate": "2023-01-01",
  "expiryDate": "2023-01-31",
  "createdAt": "2022-10-07T14:12:08.826121Z",
  "creditNoteId": "73086198-8752-4ec9-a99b-16209a32dc6c",
  "integrationIds": [
    {
      "service": "Xero",
      "id": "74ed2615-4730-49ab-9445-74f31723a206",
      "isPending": false
    }
  ]
}

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

​
id
string
required

Credit grant ID

Response

OK

​
id
string
required

Credit Grant ID

Example:

"5a0faea3-7ad5-4a83-a420-09bb6576f7e6"

​
sequenceAccountId
string
required

Sequence account ID

Example:

"a507e782-d26b-4d34-92b9-aacd1667e1f0"

​
customerId
string
required

Customer ID

Example:

"eabb3196-9c73-4c0d-b508-d3c4fc7b2cbb"

​
type
enum<string>
required

Type of the Credit - will either be CASH or USAGE

Available options:
CASH,
USAGE
Example:

"CASH"

​
currency
enum<string>
required

Currency

Available options:
ARS,
AUD,
BRL,
BGN,
CAD,
CHF,
CLP,
CNY,
COP,
CZK,
DKK,
EGP,
EUR,
GBP,
HKD,
ILS,
INR,
ISK,
JPY,
KRW,
MXN,
NOK,
NZD,
PLN,
SEK,
SGD,
THB,
USD,
UYU,
ZAR
Example:

"GBP"

​
name
string
required

Name of the Credit - will either be the currency or name of the metric

Example:

"GBP"

​
originalAmount
string
required

Amount of credits originally granted

Example:

"10"

​
currentBalance
string
required

Amount remaining of Credits Granted

Example:

"1"

​
costOfCredit
string
required

Cost of credit grant

Example:

"10"

​
createdAt
string
required

The created at

Example:

"2024-01-01T12:00:00Z"

​
metricId
string

Usage metric ID (if type is USAGE)

Example:

"b84f5290-fe95-4c6f-bedc-477700125265"

​
expiryDate
string<date>

Last Day Credit Grant can be consumed

Example:

"2024-01-02"

​
taxRateId
string

Tax Rate ID for Credit Purchase

Example:

"b3c37ea3-96bb-44fb-baed-01eb38d3328e"

​
effectiveDate
string<date>

First Day Credit Grant can be consumed

Example:

"2024-01-01"