Set Easy Mode (autopay) on a credit line

Turns Easy Mode (autopay) on or off for the consumer who owns the credit line. Easy Mode is on by default. The setting is stored on the consumer’s Credit Builder loan application, so the consumer must have one. Returns the updated credit line, with the new value in autopay_enabled. Requires the api:write or api:consumer-profile:write scope.

Turns Easy Mode (autopay) on or off for the consumer who owns the credit line. Easy Mode is on by default. The setting is stored on the consumer's Credit Builder loan application, so the consumer must have one. Returns the updated credit line, with the new value in `autopay_enabled`. Requires the `api:write` or `api:consumer-profile:write` scope.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

credit_line_idstringRequired

The id of the credit line.

Request

This endpoint expects an object.

enabledbooleanRequired

true to turn Easy Mode (autopay) on, false to turn it off. Must be a JSON boolean.

Response

idstring

consumer_idstring

current_statusstring or nullOptional<=50 characters

outstanding_balancestringOptionalRead-only

approved_loan_amountdoubleOptional

agreement_acceptedbooleanOptional

autopay_enabledboolean or nullOptionalRead-only

Whether Easy Mode (autopay) is on for the consumer’s credit line. When on, recurring transfers cover purchases made on the credit line. null when the consumer has no Credit Builder loan application yet.

Errors

400

Bad Request Error

404

Not Found Error