Update scheduled terms | Neobits API Documentation

patchUpdate scheduled terms

Changes scheduled terms; only the fields you send change. Requires terms:write. Returns 400 for terms that aren't scheduled or a startDate that isn't in the future, and 409 when the new startDate overlaps other terms.

curl --request PATCH \
  --url https://your-tenant.fuse.server.test.neobits.ai/v2/terms/0195fc07-17e7-71e7-b127-70c0a81db35a \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"terms":{"chargeCard":{"rate":0.05,"duration":300},"creditCard":{"rate":0.05,"duration":300},"otherDebts":{"rate":0.05,"duration":300},"repaymentLoan":{"rate":0.05,"duration":300},"movables":{"rate":0.05,"duration":300},"mortgages":{"rate":0.05,"duration":300},"studentLoans":{"rate":0.05,"duration":300}},"startDate":"2027-01-01T00:00:00.000Z"}'

Request

Headers

Authorization•string
Bearer token authentication using OAuth 2.0 client credentials flow.
Required

Params (path)

id•string<uuid>
The unique identifier of the terms
Required

Body

terms•object
chargeCard•object
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
duration•number
Repayment duration in months.
creditCard•object
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
duration•number
Repayment duration in months.
otherDebts•object
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
duration•number
Repayment duration in months.
repaymentLoan•object
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
duration•number
Repayment duration in months.
movables•object
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
duration•number
Repayment duration in months.
mortgages•object
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
duration•number
Repayment duration in months.
studentLoans•object
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
duration•number
Repayment duration in months.
startDate•string<date-time>
When these terms take effect.

Response

Headers

Content-Type•string
The content type of the response.
X-Request-ID•string<uuid>
UUID generated on each request. Provide this id to customer support if an error occurs.

Body

id•string<uuid>
Required
terms•object
Required
chargeCard•object
Required
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
Required
duration•number
Repayment duration in months.
Required
creditCard•object
Required
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
Required
duration•number
Repayment duration in months.
Required
otherDebts•object
Required
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
Required
duration•number
Repayment duration in months.
Required
repaymentLoan•object
Required
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
Required
duration•number
Repayment duration in months.
Required
movables•object
Required
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
Required
duration•number
Repayment duration in months.
Required
mortgages•object
Required
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
Required
duration•number
Repayment duration in months.
Required
studentLoans•object
Required
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
Required
duration•number
Repayment duration in months.
Required
startDate•string<date-time>
When these terms take effect.
Required
endDate•string<date-time>
When these terms stop applying. Null while nothing replaces them.
RequiredNullable
status•string
`ACTIVE` terms apply now, `SCHEDULED` terms start in the future and `SUPERSEDED` terms have ended.
Required
createdAt•string<date-time>
Required
updatedAt•string<date-time>
Required