AvailableInstallmentPlans

Summary

Returns the available installment plans for the specific product/basket value. Returns monthly installment amount, interest and fees. Typically used on a product page.

Resource URL	/api/v3/lookup/installment-plans
HTTP method	POST
Content type	application/json; charset=utf-8

Input parameters

Parameter name	Location	Type / Model	Description
request	Body	AvailableInstallmentPlansRequest	required

Responses

HTTP status code	Model	Comment
OK(200)	AvailableInstallmentPlansResponse
BadRequest (400)	array of ResponseMessage	Request failed. Check response model for list of Errors.
Unauthorized (401)		API user is unauthorized. Make sure X-Auth-Key header is sent.
InternalServerError (500)		Request failed due internal error. Retry request later.

Examples

{
  "amount": 750.0
}

{
  "availableInstallmentPlans": [
    {
      "basketAmount": 750.0,
      "numberOfInstallments": 3,
      "installmentAmount": 287.17,
      "firstInstallmentAmount": 382.17,
      "lastInstallmentAmount": 287.17,
      "interestRate": 19.5,
      "effectiveInterestRate": 21.34,
      "effectiveAnnualPercentageRate": 438.5,
      "totalInterestAmount": 24.51,
      "startupFee": 95.0,
      "monthlyFee": 29.0,
      "totalAmount": 956.51,
      "installmentProfileNumber": 3,
      "readMore": "https://documents.myafterpay.com/installments/v1/NO/57296/750.00_3_3_287.17_19.50_21.34_24.51_95.00_29.00_956.51"
    },
    {
      "basketAmount": 750.0,
      "numberOfInstallments": 6,
      "installmentAmount": 161.21,
      "firstInstallmentAmount": 256.21,
      "lastInstallmentAmount": 161.18,
      "interestRate": 19.5,
      "effectiveInterestRate": 21.34,
      "effectiveAnnualPercentageRate": 307.44,
      "totalInterestAmount": 43.23,
      "startupFee": 95.0,
      "monthlyFee": 29.0,
      "totalAmount": 1062.23,
      "installmentProfileNumber": 4,
      "readMore": "https://documents.myafterpay.com/installments/v1/NO/57296/750.00_4_6_161.21_19.50_21.34_43.23_95.00_29.00_1062.23"
    }
  ]
}

var AfterPayApi = require("./afterPay.js");
var apiKeyAuthentication = require("./api_key_filter");

var key = 'CHANGE_ME';
var client = new AfterPayApi().addFilter(apiKeyAuthentication.create(key));
var request = {
  "amount": 750.0
};

client.Product.availableInstallmentPlans(request, 
  function(err, response, httpRequest, httpResponse) {
  });

$LOAD_PATH.unshift File.dirname(__FILE__)
require 'after_pay.rb'
require 'json'

client = AfterPayApi::AfterPay.new(AfterPayApi::ApiKeyCredentials.new('YOUR_API_KEY'))

requestAsJson = '{"amount":750.0}'
request = AfterPayApi::Models::AvailableInstallmentPlansRequest.deserialize_object(JSON.parse(requestAsJson))


client.product.availableInstallmentPlans_async(request).then{|response|

}.execute.wait

var key = "CHANGE_ME";
var client = new ProductApi(new Configuration() { DefaultHeader = new Dictionary<string, string>() { { "X-Auth-Key", key} } });

var request = new AvailableInstallmentPlansRequest(){
  Amount = 750.0
};

var responce = client.ProductAvailableInstallmentPlans(request);