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

NameTypeDescription
idstringUnique identifier of the credit account.
typestringAlways creditAccount.
creditTermsstringThe credit terms associated with the account.
creditLimitinteger (cents)The maximum amount the customer can be loaned.
balanceinteger (cents)The amount the customer currently owes.
holdinteger (cents)The amount of authorizations pending.
availableinteger (cents)The current maximum amount the customer can be further loaned.
statusstringThe 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.