Credits
Get a Credit Grant by ID
Get a Credit Grant by ID
GET
/
credits
/
{id}
Headers
Authorization
string
requiredYour 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
requiredCredit Grant ID
Response
200 - application/json
id
string
requiredCredit Grant ID
sequenceAccountId
string
requiredSequence Account ID
customerId
string
requiredThe ID of the Customer Credit is granted to
name
string
requiredName of the Credit Grant
creditUnitType
enum<string>
requiredType of the Unit of Credit
Available options:
CURRENCY
, METRIC
currency
enum<string>
requiredCurrency of Cash Credit (if CreditUnitType is 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
metricId
string
Metric ID (if CreditUnitType is METRIC)
amount
number
requiredAmount of Units Granted
costOfCredit
number
requiredCost of Credit Grant, to be Invoiced to the Customer
taxRateId
string
Tax Rate ID for Credit Purchase
effectiveDate
string
First Day Credit Grant can be consumed
expiryDate
string
Last Day Credit Grant can be consumed
createdAt
string
requiredThe created at