POST
/
credits
curl --request POST \
  --url https://eu.sequencehq.com/api/credits \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "sequenceAccountId": "dce9ae85-d8d0-42b4-bcad-f221a64363c6",
  "customerId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
  "name": "Onboarding Credits",
  "creditUnitType": "CURRENCY",
  "currency": "GBP",
  "metricId": "f092246c-6b90-4106-bcca-304ccf06bf45",
  "amount": 10,
  "costOfCredit": 10,
  "effectiveDate": "2023-01-01",
  "expiryDate": "2023-01-31",
  "createInvoice": true
}'
{
  "id": "746fc7f2-8098-4fe7-953c-7d51c580a126",
  "sequenceAccountId": "dce9ae85-d8d0-42b4-bcad-f221a64363c6",
  "customerId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
  "name": "Onboarding Credits",
  "creditUnitType": "CURRENCY",
  "currency": "GBP",
  "metricId": "f092246c-6b90-4106-bcca-304ccf06bf45",
  "amount": 10,
  "costOfCredit": 10,
  "effectiveDate": "2023-01-01",
  "expiryDate": "2023-01-31",
  "createdAt": "2022-10-07T14:12:08.826121Z",
  "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

Body

application/json
​
sequenceAccountId
string
required

Sequence account ID

Example:

"dce9ae85-d8d0-42b4-bcad-f221a64363c6"

​
customerId
string
required

The ID of the customer credit is granted to

Example:

"61b083e0-1faa-47ca-9aeb-6205da8f6c47"

​
name
string
required

Name of the credit grant

Example:

"Onboarding Credits"

​
creditUnitType
enum<string>
required

Type of the unit of credit

Available options:
CURRENCY,
METRIC
Example:

"CURRENCY"

​
currency
enum<string>
required

Currency of cash credit (if creditUnitType is CURRENCY)

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

"GBP"

​
amount
number
required

Amount of units granted

Example:

10

​
metricId
string

Metric ID (if creditUnitType is METRIC)

Example:

"f092246c-6b90-4106-bcca-304ccf06bf45"

​
costOfCredit
number

Cost of credit grant, to be invoiced to the customer

Example:

10

​
effectiveDate
string

First day credit grant can be consumed

Example:

"2023-01-01"

​
expiryDate
string

Last day credit grant can be consumed

Example:

"2023-01-31"

​
createInvoice
boolean

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

Example:

true

Response

201
application/json
Created
​
id
string
required

Credit grant ID

Example:

"746fc7f2-8098-4fe7-953c-7d51c580a126"

​
sequenceAccountId
string
required

Sequence account ID

Example:

"dce9ae85-d8d0-42b4-bcad-f221a64363c6"

​
customerId
string
required

The ID of the customer credit is granted to

Example:

"61b083e0-1faa-47ca-9aeb-6205da8f6c47"

​
name
string
required

Name of the credit grant

Example:

"Onboarding Credits"

​
creditUnitType
enum<string>
required

Type of the unit of credit

Available options:
CURRENCY,
METRIC
Example:

"CURRENCY"

​
amount
number
required

Amount of units granted

Example:

10

​
createdAt
string
required

The creation timestamp

Example:

"2022-10-07T14:12:08.826121Z"

​
integrationIds
object[]
required

IDs in external integrations

Example:
[
  {
    "service": "Xero",
    "id": "74ed2615-4730-49ab-9445-74f31723a206",
    "isPending": false
  }
]
​
currency
enum<string>

Currency of cash credit (if creditUnitType is CURRENCY)

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

"GBP"

​
metricId
string

Metric ID (if creditUnitType is METRIC)

Example:

"f092246c-6b90-4106-bcca-304ccf06bf45"

​
costOfCredit
number

Cost of credit grant, to be invoiced to the customer

Example:

10

​
effectiveDate
string

First day credit grant can be consumed

Example:

"2023-01-01"

​
expiryDate
string

Last day credit grant can be consumed

Example:

"2023-01-31"