Orders

Get repayment estimate

Gets an order repayment estimate by Order ID.

A linkToken is required in the HTTP Header Slope-Link-Token in addition to the regular auth headers, see Link Flow.

get/v4/orders/{id}/repay-estimate

Path parameters

idstring required

The Slope order ID or the partner external order ID

Slope-Link-Tokenstring

The link token generated when the customer granted you access to their Slope account.

The order repayment estimate.

orderIdstring required

The order ID

hasPendingPaymentsboolean required

Whether the order has pending payments or another repayment in progress. If true, repayment will not be allowed.

outstandingPrincipalnumber required

The outstanding principal amount in cents

outstandingCustomerFeesnumber required

The outstanding customer fees in cents

outstandingBalancenumber required

The total outstanding balance in cents

proratedDiscountnumber required

The discount amount in cents for paying off early. NOTE: This can 0 when the order is overdue or has already received previous discounts or refunds

paymentAmountnumber required

The total amount to be charged now

No recorded changes to this endpoint across all 1 revision of this API.