Amberflo API
Defining Commitments
Create or update a commitment
1min
POST
https://app.amberflo.io/payments/pricing/amberflo/customer-commitment/installments_by_usage_commitment
Authentication
X-API-KEY
Body Parameters
body
type
customerId
*
notifyOnClientViolation
planId
*
label
*
startTimeInSeconds
cycles
*
productItemIdToUsagePerInstallmentPeriod
trueup
billOnceCreditIsFinished
promotions
reward
commitmentEndingConfig
exitClauses
One Of
payment.pricing.commitments.exit_clauses.ExitBeforeCommitmentStartWithGracePeriod.in
isProductPlanModifiable
Responses
200
Successful request
contractGenerator
One Of
payment.pricing.commitments.generators.CustomerArrearsContractGenerator.out
contract
firstCustomerPlan
firstCustomerAppliedPromotions
firstCustomerPrepaidCards
One Of
payment.billing.prepaid_to_product.PrepaidCardByPrice.out
firstPrepaidCardsOrders
One Of
payment.pricing.customer.CustomerPrepaidByPrice.out
creationTimeInSeconds
firstCustomPromotions
firstOrders
firstPlanOverrideGenerators
One Of
payment.pricing.plans.generators.CustomPlanGenerator.out
commitmentStateHistory
Updated 07 Nov 2024
Did this page help you?