Skip to main content

Credit Account Resources

CreditAccount

The CreditAccount resource represents a credit account that holds loan information for a customer.

For the full CreditAccount resource schema and field definitions, see the CreditAccount resource documentation.

Key Fields

id
string
Unique identifier of the credit account.
type
string
Always creditAccount.
creditTerms
string
The credit terms associated with the account.
creditLimit
integer (cents)
The maximum amount the customer can be loaned.
balance
integer (cents)
The amount the customer currently owes.
hold
integer (cents)
The amount of authorizations pending.
available
integer (cents)
The current maximum amount the customer can be further loaned.
status
string
The account status: Open, Frozen, or Closed.
  • Customer - The customer who owns the credit account.
  • Card - Cards associated with the credit account.
  • Repayment - Repayments made to the credit account.