Credits

Get a credit grant

Changed on

Get a credit grant by ID

get/credits/{id}

Request

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

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

OK

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' required
metricIdstring

Metric ID (if CreditUnitType is METRIC)

amountnumber required

Amount of Units Granted

costOfCreditnumber required

Cost of Credit Grant, to be Invoiced to the Customer

taxRateIdstring

Tax Rate ID for Credit Purchase

effectiveDatestring

First Day Credit Grant can be consumed

expiryDatestring

Last Day Credit Grant can be consumed

createdAtstring required

The created at

creditNoteIdstring

ID of the credit note that created this grant (if applicable)

Example response

{
  "id": "746fc7f2-8098-4fe7-953c-7d51c580a126",
  "sequenceAccountId": "dce9ae85-d8d0-42b4-bcad-f221a64363c6",
  "customerId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
  "name": "On-boarding Credits",
  "creditUnitType": "CURRENCY",
  "currency": "GBP",
  "metricId": "f092246c-6b90-4106-bcca-304ccf06bf45",
  "amount": 10,
  "costOfCredit": 10,
  "taxRateId": "179d1ab3-cc96-48e2-9310-067b0b42d47c",
  "effectiveDate": "2023-01-01",
  "expiryDate": "2023-01-31",
  "createdAt": "2022-10-07T14:12:08.826121Z",
  "creditNoteId": "73086198-8752-4ec9-a99b-16209a32dc6c",
  "integrationIds": [
    {
      "service": "Xero",
      "id": "74ed2615-4730-49ab-9445-74f31723a206",
      "isPending": false
    }
  ]
}

Changes

  • 02acff42af53Revision changes
    • breaking

      the response's property type changed from string to number for status

    • 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

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      deleted the header request parameter Sequence-Version

    • info

      added the new optional header request parameter sequence-version

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status