{"templateId":"openapi_docs","versions":[],"sharedDataIds":{"openAPIDocsStore":"oas-API Docs/@2023-11-29/api-public.yaml","sidebar":"sidebar-sidebar.yaml__api-docs_api-public"},"props":{"definitionId":"API Docs/@2023-11-29/api-public.yaml","dynamicMarkdocComponents":[],"baseSlug":"/api-docs/api-public","seo":{"title":"Payment Plans","description":"Payment plans are a specific type of hardship tool that can be used to create a temporary loan schedule for a borrower.\nLenders can create a payment plan by specifying the `paymentPlanType`, `numberOfPeriods` and `amount`. After the `numberOfPeriods`\nends, any remaining periods of the loan will be paid according to the originally scheduled recurring amount and frequency of the\nloan at the time when the payment plan was created.\n\nWhen the agreed upon recurring payment plan `amount` is less than the originally scheduled payment amount, the system uses\n`isExtendLoanDuration` to ascertain whether to keep the existing loan `duration` or automatically extend the original loan `duration`.\n\nWhen the agreed upon recurring payment plan `amount` is more than the originally scheduled recurring amount, the loan `duration`\nwill be shortened to the point where the remaining balance of the loan is paid off.\n\nOnly one active payment plan is allowed at a time. Please note that creating an active payment plan will overwrite changes\nmade to the loan schedule such as due date deferrals, change due date, and change loan terms. This is because the payment plan by\ndesign creates a new loan schedule.\n\nIf a loan is on a payment plan, other hardship tools cannot be used. Lenders must cancel the payment plan and then make any required\nloan modifications.\n\nPayment plan is presently for installment only.\n"},"itemId":"payment-plans","disableAutoScroll":true,"metadata":{},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"headers":{"accept":"*/*","accept-encoding":"br,gzip","host":"peach-docs-dev.redocly.app","user-agent":"Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)","via":"2.0 Caddy, 2.0 790dd2637efddd54756eabb102d0e234.cloudfront.net (CloudFront), 1.1 Caddy","x-amz-cf-id":"76MpEMA9vmdmeM4yfFtmK4Xi6h-ViW_AhMUqTKahvlUCk6_pffSqzQ==","x-forwarded-for":"216.73.216.253, 44.206.14.241, 64.252.68.184","x-forwarded-host":"peach-docs-dev.redocly.app","x-forwarded-proto":"https","x-request-id":"cds-312b1c19-006e-469a-aee2-741d8faca1fd"},"remoteAddr":{"hostname":"::ffff:10.0.2.113","port":56576},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"develop"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/api-docs/api-public/payment-plans","userData":{"isAuthenticated":false,"teams":["anonymous"]}}