Credits

Get and create credit requests.

get

Returns all credits for one customer. API key is used to match the customer to your account for security reasons. Ensure that the customer ID is included in the request path. Pagination is supported by passing limit and lastCreditEntry values as query parameters. You will get a lastCreditEntry value in the response of the previous request, which can be used for the next. Ensure that the lastCreditEntry value passed to the server is encoded.

Path parameters

idstringRequired

The customer ID number.

Query parameters

limitnumberOptional

The number of credits to return (for pagination).

lastCreditEntrystringOptional

The last credit entry from the previous request.

Header parameters

X-Inveterate-Api-KeystringRequired

Your private Inveterate API key.

Responses

200

Returned upon successful direct action to our database. Action is immediate.

application/json

400

Returned upon a malformed request. Check your API key, URL parameters, and body parameters when this error is returned. Generally, if you see this error, that also means NO action was taken on our backend.

application/json

500

Returned for all other errors. Generally these come from our backend. Some multipart functions may execute somewhat and then fail, causing some data to be updated.

application/json

get

HTTPcURLJavaScriptPython

GET /v2.0/admin/members/{id}/credits HTTP/1.1
Host: 
X-Inveterate-Api-Key: text
Accept: */*

{
  "message": "text",
  "data": {}
}

post

This method forwards the credit creation request to our backend. Returns the success status of the request against backend service. Like the other endpoints that make requests against our backend, the changes may not take effect immediately.

Path parameters

idstringRequired

The customer ID number.

Header parameters

X-Inveterate-Api-KeystringRequired

Your private Inveterate API key.

Body

amountnumberRequired

The amount of credits to be added to or removed from the customer's account. It can't be zero

notestringOptional

Optional note to be associated with this credit transaction

forcebooleanOptional

When force: true is included with a negative credit amount, this will disable any active credit redemption discount codes when necessary.

Responses

201

Returned upon successful request made to our backend. Requests that return this code may take a small amount of time after successful API return to fully update.

application/json

400

Returned upon a malformed request. Check your API key, URL parameters, and body parameters when this error is returned. Generally, if you see this error, that also means NO action was taken on our backend.

application/json

500

Returned for all other errors. Generally these come from our backend. Some multipart functions may execute somewhat and then fail, causing some data to be updated.

application/json

post

HTTPcURLJavaScriptPython

POST /v2.0/admin/members/{id}/credits HTTP/1.1
Host: 
X-Inveterate-Api-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "amount": 1,
  "note": "text",
  "force": true
}

{
  "message": "text",
  "data": {}
}