Create or update a commitment

1min
POST
https://app.amberflo.io/payments/pricing/amberflo/customer-commitment/subscription_usage_commitment
Authentication
X-API-KEY
apiKey
Body Parameters
body
payment.pricing.commitments.generators.SubscriptionUsageCommitmentContractGenerator.in
type
string
label
string
customerId
string
*
planId
string
*
planOverrideGenerator
payment.pricing.plans.generators.PlanGenerator.in
One Of
payment.pricing.plans.generators.CustomPlanGenerator.in 
startTimeInSeconds
integer<int64>
cycles
integer<int32>
*
commitmentEndingConfig
payment.pricing.commitments.CommitmentEndingConfig.in
promotions
payment.pricing.commitments.generators.PromotionInfo.in[]
upfrontPayments
payment.pricing.commitments.generators.PrepaidCardInput.in[]
reward
payment.pricing.commitments.generators.PrepaidCardInput.in
orders
payment.pricing.customer.CustomerSubscriptionOrder.in[]
exitClauses
payment.pricing.commitments.exit_clauses.ExitClause.in[]
One Of
payment.pricing.commitments.exit_clauses.ExitBeforeCommitmentStartWithGracePeriod.in 
notifyOnClientViolation
boolean
isProductPlanModifiable
boolean
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>
firstCustomPromotions
payment.pricing.promotions.CustomerCustomPromotion.out[]
firstOrders
payment.pricing.customer.CustomerSubscriptionOrder.out[]
firstPlanOverrideGenerators
payment.pricing.plans.generators.PlanGenerator.out[]
One Of
payment.pricing.plans.generators.CustomPlanGenerator.out 
commitmentStateHistory
map<string, payment.pricing.commitments.exit_clauses.CommitmentState.out>
﻿
﻿
Updated 07 Nov 2024
Did this page help you?
Create or update a commitment