POST
/
credits

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

Body

application/json
sequenceAccountId
string
required

Sequence Account ID

customerId
string
required

The ID of the Customer Credit is granted to

name
string
required

Name of the Credit Grant

creditUnitType
enum<string>
required

Type of the Unit of Credit

Available options:
CURRENCY,
METRIC
currency
enum<string>
required

Currency 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
required

Amount of Units Granted

costOfCredit
number

Cost of Credit Grant, to be Invoiced to the Customer

effectiveDate
string

First Day Credit Grant can be consumed

expiryDate
string

Last Day Credit Grant can be consumed

Response

201 - application/json
id
string
required

Credit Grant ID

sequenceAccountId
string
required

Sequence Account ID

customerId
string
required

The ID of the Customer Credit is granted to

name
string
required

Name of the Credit Grant

creditUnitType
enum<string>
required

Type of the Unit of Credit

Available options:
CURRENCY,
METRIC
currency
enum<string>

Currency 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
required

Amount of Units Granted

costOfCredit
number

Cost of Credit Grant, to be Invoiced to the Customer

effectiveDate
string

First Day Credit Grant can be consumed

expiryDate
string

Last Day Credit Grant can be consumed

createdAt
string
required

The created at

List all Credit GrantsGet a Credit Grant by ID