Credits

Get and create credit requests.

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.

GET/v2.0/admin/members/{id}/credits

Path parameters

id*string

Query parameters

Header parameters

Response

200400500

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

Body

application/json

message*string

The message associated with the response. Generally, the message only confirms the requested action. In the case of errors, the message will give insight into the source of the error.

data*object

The data associated with the response. Data is only returned from errors if the error originates from our backend to give further insight into the nature of the error.

Request

JavaScriptCurl

const response = await fetch('/v2.0/admin/members/{id}/credits', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "text"
}

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.

POST/v2.0/admin/members/{id}/credits

Path parameters

id*string

Header parameters

Body

application/json

amount*number

The amount of credits to add to the customer's account.

Response

201400500

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.

Body

application/json

message*string

The message associated with the response. Generally, the message only confirms the requested action. In the case of errors, the message will give insight into the source of the error.

data*object

The data associated with the response. Data is only returned from errors if the error originates from our backend to give further insight into the nature of the error.

Request

JavaScriptCurl

const response = await fetch('/v2.0/admin/members/{id}/credits', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "amount": 0
    }),
});
const data = await response.json();

Response

{
  "message": "text"
}