Credit History

Published on Jul 3, 2025

2 minute(s) read

Prev Next

Get

/credit/v1/customers/{customerId}/{holderType}/{holderId}/history

Get credit history associated with a specific entity such as a contract.

Security

HTTP

Type bearer

Path parameters

customerId

stringRequired

Examplecustomer-id-123

holderType

stringRequired

Valid values[ "contracts" ]

holderId

stringRequired

Examplecontract-id-123

Responses

200

Retrieved Credit

Expand All

object

data

object

holder

object

type

string

Entity that holds the credit

Valid values[ "contract" ]

string

ID of the entity that holds the credit.

Examplecontract-id-123

history

Array of object

History of credit changes for the holder.

object

updatedAt

string

Timestamp of when the credit was updated in ISO 8601 format.

Example2024-03-14T15:43:43.375Z

reason

string

Reason for the credit change.

ExampleCredit used to bill order 123.

actor

string

Identifier of the actor who made the credit change.

ExampleBilling Service

OneOf

object

type

string

Type of credit change. Currently only "monetary" is supported.

Valid values[ "monetary" ]

Examplemonetary

currencyCode

string

The currency code in the 3-letter ISO 4217 standard.

Min length3

Max length3

ExampleGBP

delta

integer

Change in credit value, represented in the base denomination, e.g. pence for GBP.

Example100

formattedDelta

string

Formatted change in credit value, e.g. "£1.00" for GBP.

Example£1.00

current

integer

Current value of the credit after the change, represented in the base denomination, e.g. pence for GBP.

Example1100

formattedCurrent

string

Formatted current value of the credit, e.g. "£11.00" for GBP.

Example£11.00

meta

object

Additional information about the resource.

property*

401

Unauthorized

Expand All

object

errors

Array of object

Details of problems encountered processing the request.

object

Details of a problem encountered processing the request.

status

string

The HTTP status code applicable to the problem

title

string

A short-human readable description of the problem, this should not change from occurrence to occurrence.

detail

string

A human-readable explanation specific to this occurrence of the problem.

403

Forbidden

Expand All

object

errors

Array of object

Details of problems encountered processing the request.

object

Details of a problem encountered processing the request.

status

string

The HTTP status code applicable to the problem

title

string

A short-human readable description of the problem, this should not change from occurrence to occurrence.

detail

string

A human-readable explanation specific to this occurrence of the problem.

404

Not Found

Expand All

object

errors

Array of object

Details of problems encountered processing the request.

object

Details of a problem encountered processing the request.

status

string

The HTTP status code applicable to the problem

title

string

A short-human readable description of the problem, this should not change from occurrence to occurrence.

detail

string

A human-readable explanation specific to this occurrence of the problem.

429

Too Many Requests

Expand All

object

errors

Array of object

Details of problems encountered processing the request.

object

Details of a problem encountered processing the request.

status

string

The HTTP status code applicable to the problem

title

string

A short-human readable description of the problem, this should not change from occurrence to occurrence.

detail

string

A human-readable explanation specific to this occurrence of the problem.

500

Internal Server Error

Expand All

object

errors

Array of object

Details of problems encountered processing the request.

object

Details of a problem encountered processing the request.

status

string

The HTTP status code applicable to the problem

title

string

A short-human readable description of the problem, this should not change from occurrence to occurrence.

detail

string

A human-readable explanation specific to this occurrence of the problem.

503

Service Unavailable

Expand All

object

errors

Array of object

Details of problems encountered processing the request.

object

Details of a problem encountered processing the request.

status

string

The HTTP status code applicable to the problem

title

string

A short-human readable description of the problem, this should not change from occurrence to occurrence.

detail

string

A human-readable explanation specific to this occurrence of the problem.

Was this article helpful?