Docs powered by Archbee

Amberflo API

Defining Commitments

Create or update a commitment

1min

POST
https://app.amberflo.io/payments/pricing/amberflo/customer-commitment/single_total_price_true_up
Authentication
X-API-KEY
apiKey
Body Parameters
body
payment.pricing.commitments.generators.MinTotalPriceToFixPlanAndDiscounts.in
type
string
id
string
cycles
integer<int32>
totalCommittedPrice
integer<int64>
planId
string
promotionIds
string[]
useTrueUp
boolean
customerId
string
label
string
commitmentEndingConfig
payment.pricing.commitments.CommitmentEndingConfig.in
exitClauses
payment.pricing.commitments.exit_clauses.ExitClause.in[]
One Of
payment.pricing.commitments.exit_clauses.ExitBeforeCommitmentStartWithGracePeriod.in 
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

Doc contributor

Did this page help you?

Create or update a commitment

Create or update a commitment

Docs powered by Archbee

Curl

JS

Ruby

Python

curl --location 'https://app.amberflo.io/payments/pricing/amberflo/customer-commitment/single_total_price_true_up' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"body":{}}'

Responses

200

// Successful request 
{
  "contractGenerator": {},
  "contract": {
    "id": "",
    "type": "",
    "accountId": "",
    "customerId": "",
    "customerObligations": {},
    "accountObligations": {},
    "commitmentViolationPolicy": {
      "notifyPerCustomerViolations": false,
      "notifyPerAccountViolations": false,
      "compensateOnCustomerViolation": false,
      "compensateOnAccountViolation": false
    },
    "timeRange": {
      "startTimeInSeconds": "",
      "endTimeInSeconds": ""
    },
    "productId": "",
    "commitmentEndingConfig": {
      "commitmentRestartConfig": {
        "latestDecisionTimeSeconds": "",
        "optOut": false
      },
      "extendPrepaidCardEndTimeInSeconds": ""
    },
    "exitClauses": {}
  },
  "firstCustomerPlan": {
    "productId": "",
    "productPlanId": "",
    "customerId": "",
    "startTimeInSeconds": "",
    "endTimeInSeconds": "",
    "relationId": "",
    "createdTimeInSeconds": ""
  },
  "firstCustomerAppliedPromotions": [
    {
      "id": "",
      "productId": "",
      "customerId": "",
      "promotionId": "",
      "appliedTimeInSeconds": "",
      "addedTimeInSeconds": "",
      "removedTimeInSeconds": "",
      "relationId": "",
      "appliedTimeRange": {
        "startTimeInSeconds": "",
        "endTimeInSeconds": ""
      },
      "priority": 0,
      "removalContext": "",
      "commitmentId": "",
      "entityProductInvoices": [
        {
          "invoiceUri": "",
          "createdTimeInSeconds": "",
          "amount": 0,
          "invoiceAmount": 0
        }
      ],
      "amountLeftInCycle": 0,
      "totalAmountLeft": 0
    }
  ],
  "firstCustomerPrepaidCards": {},
  "firstPrepaidCardsOrders": {},
  "creationTimeInSeconds": "",
  "firstCustomPromotions": [
    {
      "promotion": {},
      "customerAppliedPromotion": {
        "id": "",
        "productId": "",
        "customerId": "",
        "promotionId": "",
        "appliedTimeInSeconds": "",
        "addedTimeInSeconds": "",
        "removedTimeInSeconds": "",
        "relationId": "",
        "appliedTimeRange": {
          "startTimeInSeconds": "",
          "endTimeInSeconds": ""
        },
        "priority": 0,
        "removalContext": "",
        "commitmentId": "",
        "entityProductInvoices": [
          {
            "invoiceUri": "",
            "createdTimeInSeconds": "",
            "amount": 0,
            "invoiceAmount": 0
          }
        ],
        "amountLeftInCycle": 0,
        "totalAmountLeft": 0
      }
    }
  ],
  "firstOrders": [
    {
      "customerId": "",
      "id": "",
      "orderItems": [
        {
          "id": "",
          "quantity": 0,
          "resourceId": "",
          "dimensions": "",
          "totalPrice": 0
        }
      ],
      "productItemId": "",
      "productPlanId": "",
      "appliedTimeRange": {
        "startTimeInSeconds": "",
        "endTimeInSeconds": ""
      },
      "billingPeriods": "",
      "label": "",
      "subscriptionSettings": {
        "cancellationRule": "",
        "chargeExecution": "",
        "purchaseRule": "",
        "subscriptionRate": "",
        "isPricedPerRate": false,
        "isCancellable": false
      },
      "addedTimeInSeconds": "",
      "commitmentId": "",
      "prepaidUris": [
        ""
      ],
      "removedTimeInSeconds": "",
      "removalContext": ""
    }
  ],
  "firstPlanOverrideGenerators": {},
  "commitmentStateHistory": ""
}

// Successful request 
{
  "contractGenerator": {},
  "contract": {
    "id": "",
    "type": "",
    "accountId": "",
    "customerId": "",
    "customerObligations": {},
    "accountObligations": {},
    "commitmentViolationPolicy": {
      "notifyPerCustomerViolations": false,
      "notifyPerAccountViolations": false,
      "compensateOnCustomerViolation": false,
      "compensateOnAccountViolation": false
    },
    "timeRange": {
      "startTimeInSeconds": "",
      "endTimeInSeconds": ""
    },
    "productId": "",
    "commitmentEndingConfig": {
      "commitmentRestartConfig": {
        "latestDecisionTimeSeconds": "",
        "optOut": false
      },
      "extendPrepaidCardEndTimeInSeconds": ""
    },
    "exitClauses": {}
  },
  "firstCustomerPlan": {
    "productId": "",
    "productPlanId": "",
    "customerId": "",
    "startTimeInSeconds": "",
    "endTimeInSeconds": "",
    "relationId": "",
    "createdTimeInSeconds": ""
  },
  "firstCustomerAppliedPromotions": [
    {
      "id": "",
      "productId": "",
      "customerId": "",
      "promotionId": "",
      "appliedTimeInSeconds": "",
      "addedTimeInSeconds": "",
      "removedTimeInSeconds": "",
      "relationId": "",
      "appliedTimeRange": {
        "startTimeInSeconds": "",
        "endTimeInSeconds": ""
      },
      "priority": 0,
      "removalContext": "",
      "commitmentId": "",
      "entityProductInvoices": [
        {
          "invoiceUri": "",
          "createdTimeInSeconds": "",
          "amount": 0,
          "invoiceAmount": 0
        }
      ],
      "amountLeftInCycle": 0,
      "totalAmountLeft": 0
    }
  ],
  "firstCustomerPrepaidCards": {},
  "firstPrepaidCardsOrders": {},
  "creationTimeInSeconds": "",
  "firstCustomPromotions": [
    {
      "promotion": {},
      "customerAppliedPromotion": {
        "id": "",
        "productId": "",
        "customerId": "",
        "promotionId": "",
        "appliedTimeInSeconds": "",
        "addedTimeInSeconds": "",
        "removedTimeInSeconds": "",
        "relationId": "",
        "appliedTimeRange": {
          "startTimeInSeconds": "",
          "endTimeInSeconds": ""
        },
        "priority": 0,
        "removalContext": "",
        "commitmentId": "",
        "entityProductInvoices": [
          {
            "invoiceUri": "",
            "createdTimeInSeconds": "",
            "amount": 0,
            "invoiceAmount": 0
          }
        ],
        "amountLeftInCycle": 0,
        "totalAmountLeft": 0
      }
    }
  ],
  "firstOrders": [
    {
      "customerId": "",
      "id": "",
      "orderItems": [
        {
          "id": "",
          "quantity": 0,
          "resourceId": "",
          "dimensions": "",
          "totalPrice": 0
        }
      ],
      "productItemId": "",
      "productPlanId": "",
      "appliedTimeRange": {
        "startTimeInSeconds": "",
        "endTimeInSeconds": ""
      },
      "billingPeriods": "",
      "label": "",
      "subscriptionSettings": {
        "cancellationRule": "",
        "chargeExecution": "",
        "purchaseRule": "",
        "subscriptionRate": "",
        "isPricedPerRate": false,
        "isCancellable": false
      },
      "addedTimeInSeconds": "",
      "commitmentId": "",
      "prepaidUris": [
        ""
      ],
      "removedTimeInSeconds": "",
      "removalContext": ""
    }
  ],
  "firstPlanOverrideGenerators": {},
  "commitmentStateHistory": ""
}