Create custom commitment contract
1 min
POST
https://app.amberflo.io/payments/pricing/amberflo/customer-commitment/custom_commitment
bodyobjectCustom contract generator configuration with rewards, promotions, true-up settings, and payment options
200Custom commitment contract successfully created
400Bad request - invalid custom commitment configuration or conflicting parameters
403Forbidden - customer not authorized for custom commitment terms
409Conflict - custom commitment terms incompatible with existing customer agreements
curl --request POST \
--url https://app.amberflo.io/payments/pricing/amberflo/customer-commitment/custom_commitment \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"type": "custom_commitment",
"customerId": "",
"planId": "",
"label": "",
"cycles": 0,
"upfrontPayments": [
{
"value": "",
"label": ""
}
],
"trueups": [
{
"minimumPayment": "",
"interval": ""
}
],
"credits": [
{
"value": "",
"label": ""
}
],
"rewards": [
{
"value": "",
"label": ""
}
],
"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"
}
},
"exitClauses": {
"type": "termination_grace_period",
"gracePeriodInDays": 0
}
}'