Create or update a Custom Commitment

1min

POST
https://app.amberflo.io/payments/pricing/amberflo/customer-commitment/custom_commitment
An advanced contract generator that receives a Reward, Promotions TrueUpInput, Installments, Credits, and Upfront and creates a contract with credit obligations.
Authentication
X-API-KEY
apiKey
Body Parameters
body
payment.pricing.commitments.generators.CustomCommitmentContractGenerator.in
type
string
customerId
string
*
notifyOnClientViolation
boolean
planId
string
*
label
string
*
startTimeInSeconds
integer<int64>
cycles
integer<int32>
*
upfrontPayments
payment.pricing.commitments.generators.PrepaidCardInput.in[]
installmentSchedule
object[]
trueups
payment.pricing.commitments.generators.TrueUpInput.in[]
credits
payment.pricing.commitments.generators.PrepaidCardInput.in[]
rewards
payment.pricing.commitments.generators.PrepaidCardInput.in[]
promotions
payment.pricing.commitments.generators.PromotionInfo.in[]
Responses
200
Successful request
payment.pricing.customer.CustomerCommitmentContract.out
contractGenerator
payment.pricing.commitments.generators.ContractGenerator.out
One Of
payment.pricing.commitments.generators.CustomerArrearsContractGenerator.out 
contract
payment.pricing.commitments.CommitmentContract.out
firstCustomerPlan
payment.pricing.customer.CustomerProductPlan.out
firstCustomerAppliedPromotions
payment.pricing.customer.CustomerAppliedPromotion.out[]
firstCustomerPrepaidCards
payment.billing.prepaid_to_product.PrepaidCard.out[]
One Of
payment.billing.prepaid_to_product.PrepaidCardByPrice.out 
firstPrepaidCardsOrders
payment.pricing.customer.CustomerPrepaid.out[]
One Of
payment.pricing.customer.CustomerPrepaidByPrice.out 
creationTimeInSeconds
integer<int64>
﻿
﻿

Updated 30 Sep 2024

Did this page help you?

Create or update an Arrears Commitment with True-up

Create or update an Installments Commitment