Create installment-based commitment

1 min

code examples curl location 'https //app amberflo io/payments/pricing/amberflo/customer commitment/installments commitment' \\ \ header 'accept application/json' \\ \ header 'content type application/json' \\ \ data '{ "type" "installments commitment", "customerid" "", "planid" "", "planoverridegenerator" { "type" "custom pricing plan", "id" "", "billingperiod" {}, "planname" "", "entitlements" \[ { "id" "", "apiname" "" } ], "pricegenerators" { "dimensionkeys" \[], "productitemid" "", "pricetiers" \[ { "leafnodetype" "" } ], "type" "cost plus dimension" }, "invoicebasedfees" { "type" "constant invoice ratio fee" } }, "label" "", "cycles" 0, "trueup" { "minimumpayment" "", "interval" "" }, "credits" { "value" "", "label" "" }, "reward" { "value" "", "label" "" }, "exitclauses" { "type" "termination grace period", "graceperiodindays" 0 } }'var myheaders = new headers(); myheaders append("accept", "application/json"); myheaders append("content type", "application/json"); var raw = json stringify({ "type" "installments commitment", "customerid" "", "planid" "", "planoverridegenerator" { "type" "custom pricing plan", "id" "", "billingperiod" {}, "planname" "", "entitlements" \[ { "id" "", "apiname" "" } ], "pricegenerators" { "dimensionkeys" \[], "productitemid" "", "pricetiers" \[ { "leafnodetype" "" } ], "type" "cost plus dimension" }, "invoicebasedfees" { "type" "constant invoice ratio fee" } }, "label" "", "cycles" 0, "trueup" { "minimumpayment" "", "interval" "" }, "credits" { "value" "", "label" "" }, "reward" { "value" "", "label" "" }, "exitclauses" { "type" "termination grace period", "graceperiodindays" 0 } }); var requestoptions = { method 'post', headers myheaders, body raw, redirect 'follow' }; fetch("https //app amberflo io/payments/pricing/amberflo/customer commitment/installments commitment", requestoptions) then(response => response text()) then(result => console log(result)) catch(error => console log('error', error));require "uri" require "json" require "net/http" url = uri("https //app amberflo io/payments/pricing/amberflo/customer commitment/installments commitment") https = net http new(url host, url port) https use ssl = true request = net http post new(url) request\["accept"] = "application/json" request\["content type"] = "application/json" request body = json dump({ "type" "installments commitment", "customerid" "", "planid" "", "planoverridegenerator" { "type" "custom pricing plan", "id" "", "billingperiod" {}, "planname" "", "entitlements" \[ { "id" "", "apiname" "" } ], "pricegenerators" { "dimensionkeys" \[], "productitemid" "", "pricetiers" \[ { "leafnodetype" "" } ], "type" "cost plus dimension" }, "invoicebasedfees" { "type" "constant invoice ratio fee" } }, "label" "", "cycles" 0, "trueup" { "minimumpayment" "", "interval" "" }, "credits" { "value" "", "label" "" }, "reward" { "value" "", "label" "" }, "exitclauses" { "type" "termination grace period", "graceperiodindays" 0 } }) response = https request(request) puts response read body import requests import json url = "https //app amberflo io/payments/pricing/amberflo/customer commitment/installments commitment" payload = json dumps({ "type" "installments commitment", "customerid" "", "planid" "", "planoverridegenerator" { "type" "custom pricing plan", "id" "", "billingperiod" {}, "planname" "", "entitlements" \[ { "id" "", "apiname" "" } ], "pricegenerators" { "dimensionkeys" \[], "productitemid" "", "pricetiers" \[ { "leafnodetype" "" } ], "type" "cost plus dimension" }, "invoicebasedfees" { "type" "constant invoice ratio fee" } }, "label" "", "cycles" 0, "trueup" { "minimumpayment" "", "interval" "" }, "credits" { "value" "", "label" "" }, "reward" { "value" "", "label" "" }, "exitclauses" { "type" "termination grace period", "graceperiodindays" 0 } }) headers = { 'accept' 'application/json', 'content type' 'application/json' } response = requests request("post", url, headers=headers, data=payload) print(response text) responses // installment commitment successfully created { "contractgenerator" {}, "contract" { "id" "", "type" "", "accountid" "", "customerid" "", "customerobligations" {}, "accountobligations" {}, "commitmentviolationpolicy" { "notifypercustomerviolations" false, "notifyperaccountviolations" false, "compensateoncustomerviolation" false, "compensateonaccountviolation" false }, "timerange" { "starttimeinseconds" "", "endtimeinseconds" "" }, "productid" "", "commitmentendingconfig" { "commitmentrestartconfig" { "latestdecisiontimeseconds" "", "optout" false }, "extendprepaidcardendtimeinseconds" "" }, "exitclauses" {} }, "firstcustomerplan" { "productid" "", "productplanid" "", "customerid" "", "starttimeinseconds" "", "endtimeinseconds" "", "relationid" "", "createdtimeinseconds" "" }, "firstcustomerappliedpromotions" \[ { "id" "", "productid" "", "customerid" "", "promotionid" "", "appliedtimeinseconds" "", "addedtimeinseconds" "", "removedtimeinseconds" "", "relationid" "", "appliedtimerange" { "starttimeinseconds" "", "endtimeinseconds" "" }, "priority" 0, "removalcontext" "", "commitmentid" "", "entityproductinvoices" \[ { "invoiceuri" "", "createdtimeinseconds" "", "amount" 0, "invoiceamount" 0 } ], "amountleftincycle" 0, "totalamountleft" 0 } ], "firstcustomerprepaidcards" {}, "firstprepaidcardsorders" {}, "creationtimeinseconds" "", "firstcustompromotions" \[ { "promotion" {}, "customerappliedpromotion" { "id" "", "productid" "", "customerid" "", "promotionid" "", "appliedtimeinseconds" "", "addedtimeinseconds" "", "removedtimeinseconds" "", "relationid" "", "appliedtimerange" { "starttimeinseconds" "", "endtimeinseconds" "" }, "priority" 0, "removalcontext" "", "commitmentid" "", "entityproductinvoices" \[ { "invoiceuri" "", "createdtimeinseconds" "", "amount" 0, "invoiceamount" 0 } ], "amountleftincycle" 0, "totalamountleft" 0 } } ], "firstorders" \[ { "customerid" "", "id" "", "orderitems" \[ { "id" "", "quantity" 0, "resourceid" "", "dimensions" "", "totalprice" 0 } ], "productitemid" "", "productplanid" "", "appliedtimerange" { "starttimeinseconds" "", "endtimeinseconds" "" }, "billingperiods" "", "label" "", "subscriptionsettings" { "cancellationrule" "", "chargeexecution" "", "purchaserule" "", "subscriptionrate" "", "ispricedperrate" false, "iscancellable" false }, "addedtimeinseconds" "", "commitmentid" "", "prepaiduris" \[ "" ], "removedtimeinseconds" "", "removalcontext" "" } ], "firstplanoverridegenerators" {}, "commitmentstatehistory" "" }// bad request invalid installment schedule or payment configuration // forbidden customer not eligible for installment payment terms // conflict installment commitment conflicts with existing payment agreements