Create installment-based commitment

1 min

POST

https://app.amberflo.io/payments/pricing/amberflo/customer-commitment/installments_commitment

Creates a customer commitment contract with structured installment payment schedules.

This allows customers to spread payment obligations across multiple billing cycles while securing usage-based pricing benefits. Each installment payment automatically provisions corresponding prepaid credits.

Use this for customers wanting to spread large commitment payments over time, cash flow management for enterprise accounts, or seasonal businesses with variable payment capabilities.

bodyobjectInstallment contract generator with payment cycle schedule and prepaid card configuration for structured payment commitments

200Installment commitment successfully created

400Bad request - invalid installment schedule or payment configuration

403Forbidden - customer not eligible for installment payment terms

409Conflict - installment commitment conflicts with existing payment agreements

curl --request POST \
     --url 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
     }
     }'