Credits

Create a new credit grant

Changed on

Create a new credit grant

post/credits

Request

  • Base URL
    https://sandbox.sequencehq.com/api
  • URL
    https://sandbox.sequencehq.com/api/credits
  • Auth
    none declared. Required headers: Authorization

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

sequence-version'2024-07-30'

Use this header to select an API version

Request body

sequenceAccountIdstring required

Sequence account ID

customerIdstring required

The ID of the customer credit is granted to

namestring required

Name of the credit grant

creditUnitType'CURRENCY' | 'METRIC' required
currency'AED' | 'ARS' | 'AUD' | 'BRL' | 'BGN' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CZK' | 'DKK' | 'EGP' | 'EUR' | 'GBP' | 'HKD' | 'ILS' | 'INR' | 'ISK' | 'JPY' | 'KRW' | 'MXN' | 'NOK' | 'NZD' | 'PLN' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'USD' | 'UYU' | 'ZAR' required
metricIdstring

Metric ID (if creditUnitType is METRIC)

amountnumber required

Amount of units granted

costOfCreditnumber

Cost of credit grant, to be invoiced to the customer

effectiveDatestring

First day credit grant can be consumed

expiryDatestring

Last day credit grant can be consumed

createInvoiceboolean

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

Example request

{
  "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
}

Response

Created

idstring required

Credit grant ID

sequenceAccountIdstring required

Sequence account ID

customerIdstring required

The ID of the customer credit is granted to

namestring required

Name of the credit grant

creditUnitType'CURRENCY' | 'METRIC' required
currency'AED' | 'ARS' | 'AUD' | 'BRL' | 'BGN' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CZK' | 'DKK' | 'EGP' | 'EUR' | 'GBP' | 'HKD' | 'ILS' | 'INR' | 'ISK' | 'JPY' | 'KRW' | 'MXN' | 'NOK' | 'NZD' | 'PLN' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'USD' | 'UYU' | 'ZAR'
metricIdstring

Metric ID (if creditUnitType is METRIC)

amountnumber required

Amount of units granted

costOfCreditnumber

Cost of credit grant, to be invoiced to the customer

effectiveDatestring

First day credit grant can be consumed

expiryDatestring

Last day credit grant can be consumed

createdAtstring required

The creation timestamp

Example response

{
  "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
    }
  ]
}

Changes

  • 02acff42af53Revision changes
    • breaking

      the response's property format changed from date to no format for status

    • breaking

      the response's property format changed from date to no format for status

    • warning

      deleted the header request parameter Sequence-Version

    • info

      added the new optional header request parameter sequence-version

    • info

      the request property format was generalized from date to no format

    • info

      the request property format was generalized from date to no format