increase-test
GET/programs/{program_id}

Retrieve a program

Retrieves a program by its identifier. Use program_id to select the program whose compliance and commercial terms you want to review. The response includes the program's name, bank, interest rate, and timestamps.

1 parameter
program_idstringrequired
The identifier of the program to retrieve.

3 status codes
200Returns the program object, including its identifier, name, bank, interest rate, and creation and update timestamps.
bankstringrequired
The Bank the Program is with.
Allowed:core_bankfirst_internet_bankgrasshopper_bankincrease_bank
billing_account_idstringrequired
The Program billing account.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Program was created.
default_digital_card_profile_idstringrequired
The default configuration for digital cards attached to this Program.
idstringrequired
The Program identifier.
interest_ratestringrequired
The Interest Rate currently being earned on the accounts in this program, as a string containing a decimal number. For example, a 1% interest rate would be represented as "0.01".
lendingobjectrequired
The lending details for the program.
namestringrequired
The name of the Program.
typestringrequired
A constant representing the object's type. For this resource it will always be `program`.
Allowed:program
updated_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Program was last updated.
4XXReturned when the request cannot be processed because of a client error.
5XXReturned when the server encounters an error processing the request.

Error handling

The program_id path parameter must identify an existing program.