v1

latestOpenAPI 3.0.02026-07-261733191.1 MB

Credits

Delete a credit grant

Delete a credit grant by ID

delete/credits/{id}

Path parameters

idstring required

Credit grant ID

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

sequence-version'2024-07-30'

Use this header to select an API version

Response

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