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
amount
number
required

Amount of Units Granted

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
customerId
string
required

The ID of the Customer Credit is granted to

name
string
required

Name of the Credit Grant

sequenceAccountId
string
required

Sequence Account ID

costOfCredit
number

Cost of Credit Grant, to be Invoiced to the Customer

createInvoice
boolean

If true we will create an invoice to charge the customer for this grant

effectiveDate
string

First Day Credit Grant can be consumed

expiryDate
string

Last Day Credit Grant can be consumed

metricId
string

Metric ID (if CreditUnitType is METRIC)

Response

201 - application/json
amount
number
required

Amount of Units Granted

createdAt
string
required

The created at

creditUnitType
enum<string>
required

Type of the Unit of Credit

Available options:
CURRENCY,
METRIC
customerId
string
required

The ID of the Customer Credit is granted to

id
string
required

Credit Grant ID

integrationIds
object[]
required

IDs in external integrations

name
string
required

Name of the Credit Grant

sequenceAccountId
string
required

Sequence Account ID

costOfCredit
number

Cost of Credit Grant, to be Invoiced to the Customer

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
effectiveDate
string

First Day Credit Grant can be consumed

expiryDate
string

Last Day Credit Grant can be consumed

metricId
string

Metric ID (if CreditUnitType is METRIC)