Create or update a commitment

1 min

POST

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

Creates a new customer commitment contract or updates an existing one.

This establishes binding contractual agreements defining usage obligations, pricing terms, and commitment periods. Supports various commitment types including upfront, arrears, installments, and subscription billing.

Use this for establishing contractual usage commitments that lock in specific pricing terms for defined periods.

bodyobjectContract generator configuration with commitment terms, timeline, and pricing rules

200Commitment successfully created or updated

400Bad request - invalid commitment parameters

403Forbidden - insufficient permissions

409Conflict with existing customer pricing

curl --request POST \
     --url https://app.amberflo.io/payments/pricing/amberflo/customer-commitment \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "type": "arrears_commitment_with_trueup",
     "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": ""
     },
     "reward": {
     "value": "",
     "label": ""
     },
     "exitClauses": {
     "type": "termination_grace_period",
     "gracePeriodInDays": 0
     }
     }'