Statements

List installment plans

Changed on

List the installment plans for a given financial account.

get/v1/financial_accounts/{financial_account_token}/installment_plans

Request

  • Base URL
    https://sandbox.lithic.com
  • URL
    https://sandbox.lithic.com/v1/financial_accounts/{financial_account_token}/installment_plans
  • Auth
    API key in header Authorization

Path parameters

financial_account_tokenstring uuid required

Globally unique identifier for financial account.

Query parameters

ending_beforestring

A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item.

page_sizeinteger

Page size (for pagination).

state'PENDING' | 'ACTIVE' | 'REBUILD_IN_PROGRESS' | 'FULLY_PAID' | 'CANCELLED'

State of the installment plan. A plan is REBUILD_IN_PROGRESS while its loan tapes are being rebuilt, during which its payment totals are being recomputed and should not be treated as final

Only installment plans in this state will be included.

starting_afterstring

A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item.

Response

OK

has_moreboolean required

Changes