GET
/
credits
/
{id}

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

200 - application/json
id
string
required

Credit Grant ID

sequenceAccountId
string
required

Sequence account ID

customerId
string
required

Customer ID

type
enum<string>
required

Type of the Credit - will either be CASH or USAGE

Available options:
CASH,
USAGE
currency
enum<string>
required

Currency

Available options:
ARS,
AUD,
BRL,
CAD,
CHF,
CNY,
COP,
CZK,
DKK,
EUR,
GBP,
HKD,
ILS,
JPY,
KRW,
MXN,
NOK,
NZD,
PLN,
SEK,
SGD,
THB,
USD,
UYU,
ZAR
name
string
required

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

originalAmount
string
required

Amount of credits originally granted

currentBalance
string
required

Amount remaining of Credits Granted

costOfCredit
string
required

Cost of credit grant

createdAt
string
required

The created at

metricId
string

Usage metric ID (if type is USAGE)

expiryDate
string

Last Day Credit Grant can be consumed

taxRateId
string

Tax Rate ID for Credit Purchase

effectiveDate
string

First Day Credit Grant can be consumed

Create a new CreditGrantList all Billing Schedules