Extend a product plan

1 min

POST

https://app.amberflo.io/payments/pricing/amberflo/account-pricing/product-plan-extension

Add an existing product item price to a product plan.

Body Parameters

bodypayment.pricing.input_representation.ProductPlanExtension.in
- itemPriceIdstring
- productPlanIdstring

Responses

200Successful request

payment.pricing.ProductPlan.out
- idstring
- productIdstring
- productItemPriceIdsMapmap<string, string>
- billingPeriodpayment.pricing.BillingPeriod.out
  - intervalpayment.pricing.BillingPeriodInterval.out
  - intervalsCountinteger<int32>
- planLevelFreeTiernumber
- invoiceBasedFeeIdsstring[]
- planMinimumPaymentnumber
  Description
  A minimum payment for the entire plan.
- minimumPaymentGranularitypayment.pricing.price.UsageGranularity.out
  Description
  Determines the granularity of the payment. only 'hourly' and 'entire_invoice_period' are allowed, currently.
- productPlanNamestring
- descriptionstring
- lastUpdateTimeInMillisinteger<int64>
- feeMapmap<string, payment.pricing.ProductPlanFee.out>
- entitlementspayment.pricing.Entitlements.Entitlement.out[]
  - idstringrequired
    Description
    Id for the Entitlement.
  - labelstring
    Description
    Label for the Entitlement.
  - apiNamestringrequired
    Description
    User-defined API Name for the Entitlement.
- lockingStatuscom.amberflo.service.common.LockingStatus.out
- isDefaultboolean
- successorPlanIdstring
- transitionStrategypayment.pricing.SuccessorPlanTransitionStrategy.out
- typestring
- prepaidBuyingRulespayment.pricing.prepaid.PlanPrepaidBuyingRules.out
  Description
  Rules for the prepaid
  - planFixedFeeIdsToPrepaystring[]
  - planRecurringPrepaidAmountnumber
    Description
    Recurring prepaid to purchase on every billing period on a plan level.
  - productItemRecurringPrepaidAmountpayment.pricing.prepaid.PrepaidProductItem.out[]
    Description
    Recurring prepaid to purchase on every billing period on a product item level.
    - productItemIdstring
      Description
      Product item id that is associated with amount of prepaid.
    - prepaidAmountnumber
      Description
      Prepaid amount that is associated with the object.
  - walletMinPrepaidAvailablenumber
    Description
    Minimum amount that the prepaid wallet should hold. If it's below, Amberflo will automatically purchase more.
  - productItemMinPrepaidAvailablemap<string, number>
    Description
    Key: product item id. Minimum amount that prepaid cards for a product item should hold. If it's below, Amberflo will automatically purchase more.
- planGeneratorpayment.pricing.plans.generators.PlanGenerator.out
  Description
  The template of the plan generator
  - payment.pricing.plans.generators.CustomPlanGenerator.out
    - typestring
      Description
      Type of template, automatically populated.
      Default
      custom_pricing_plan
    - idstringrequired
      Description
      Id associated with the plan.
    - billingPeriodpayment.pricing.BillingPeriod.outrequired
      Description
      Billing period of the plan: how often an invoice is generated.
      - intervalpayment.pricing.BillingPeriodInterval.out
      - intervalsCountinteger<int32>
    - planLevelFreeTiernumber
      Description
      Amount that user can use for free without paying on a plan level.
    - invoiceBasedFeeIdsstring[]
      Description
      A set of fee ids that can calculate an invoice's cost in a custom way.
    - planMinimumPaymentnumber
      Description
      A minimum payment for the entire plan.
    - minimumPaymentGranularitypayment.pricing.price.UsageGranularity.out
      Description
      Determines the granularity of the payment. only 'hourly' and 'entire_invoice_period' are allowed, currently.
    - planNamestringrequired
      Description
      Name of the plan. Useful for displaying to users.
    - descriptionstring
      Description
      Description of the plan. Useful for displaying to users.
    - feeMapmap<string, payment.pricing.ProductPlanFee.out>
      Description
      Fee Id to fee that maps to product plan fee.
    - entitlementspayment.pricing.Entitlements.Entitlement.out[]
      Description
      A list of entitlements: Entitlement is a feature flag for a specified entitlement id or an api name.
      - idstringrequired
        Description
        Id for the Entitlement.
      - labelstring
        Description
        Label for the Entitlement.
      - apiNamestringrequired
        Description
        User-defined API Name for the Entitlement.
    - lockingStatuscom.amberflo.service.common.LockingStatus.out
      Description
      Indicates if the plan can be modified or not.
    - isDefaultboolean
      Description
      Indicates if the plan is the default plan for users.
    - successorPlanIdstring
      Description
      Indicates if the plan has a successor. Gives the option to automatically assign a new plan for a given plan once current plan is deprecated.
    - transitionStrategypayment.pricing.SuccessorPlanTransitionStrategy.out
      Description
      Successor plan transition: whether to wait for end of billing cycle or not.
    - prepaidBuyingRulespayment.pricing.prepaid.PlanPrepaidBuyingRules.out
      Description
      Rules for the prepaid
      - planFixedFeeIdsToPrepaystring[]
      - planRecurringPrepaidAmountnumber
        Description
        Recurring prepaid to purchase on every billing period on a plan level.
      - productItemRecurringPrepaidAmountpayment.pricing.prepaid.PrepaidProductItem.out[]
        Description
        Recurring prepaid to purchase on every billing period on a product item level.
        productItemIdstring
        Description
        Product item id that is associated with amount of prepaid.
        prepaidAmountnumber
        Description
        Prepaid amount that is associated with the object.
      - walletMinPrepaidAvailablenumber
        Description
        Minimum amount that the prepaid wallet should hold. If it's below, Amberflo will automatically purchase more.
      - productItemMinPrepaidAvailablemap<string, number>
        Description
        Key: product item id. Minimum amount that prepaid cards for a product item should hold. If it's below, Amberflo will automatically purchase more.
    - planCurrencystring
      Example
      USD
      Description
      The customized currency for the plan in ISO 4217 format.
    - priceGeneratorspayment.pricing.price.generators.PriceGenerator.out[]required
      Description
      List of price generators to use in the plan. Can be any price generator.
      - payment.pricing.price.generators.CostPlusDimensionPriceGenerator.out
        dimensionKeysstring[]required
        Description
        Keys associated with dimension values.
        idstring
        Description
        Id associated with the price.
        productItemIdstringrequired
        Description
        Product item id associated with the price.
        productItemInvoiceLabelstring
        Description
        Optional product item invoice label. Used for renaming invoice items.
        productItemPriceNamestring
        Description
        Name of the price machine. Useful for displaying to users.
        lockingStatuscom.amberflo.service.common.LockingStatus.out
        Description
        Indicates if the meter can be modified or not.
        scalarnumber
        Description
        Scalar value used to scale usage
        dimensionalScalarspayment.pricing.price.DimensionalScalar.out[]
        Description
        Scalars for scaling usage by dimensions
        dimensionConstraintMapmap<string, string>
        scalarnumber
        priceTierspayment.pricing.price.generators.TieredPriceGroupInfo.out[]required
        Description
        Price for each tier. Leaf node type must be LeafNode
        dimensionValuesstring[]
        priceTierspayment.pricing.price.PriceTier.out[]
        Max depth limit reached
        leafNodeTypestringrequired
        allowPartialBatchboolean
        Description
        Count tier rates in cents.
        typestring
        Description
        Type of template, automatically populated.
        Default
        cost_plus_dimension
      - payment.pricing.price.generators.CostPlusNoDimensionPriceGenerator.out
        idstring
        Description
        Id associated with the price.
        productItemIdstringrequired
        Description
        Product item id associated with the price.
        productItemInvoiceLabelstring
        Description
        Optional product item invoice label. Used for renaming invoice items.
        productItemPriceNamestring
        Description
        Name of the price machine. Useful for displaying to users.
        scalarnumber
        Description
        Scalar value used to scale usage
        dimensionalScalarspayment.pricing.price.DimensionalScalar.out[]
        Description
        Scalars for scaling usage by dimensions
        Max depth limit reached
        priceTierspayment.pricing.price.PriceTier.out[]required
        Description
        Price for each tier.
        Max depth limit reached
        allowPartialBatchboolean
        Description
        Count tier rates in cents.
        typestring
        Description
        Type of template, automatically populated.
        Default
        cost_plus_no_dimension
      - payment.pricing.price.generators.FlatRatePriceGenerator.out
        Max depth limit reached
      - payment.pricing.price.generators.FlatRateWithOveragesPriceGenerator.out
        Max depth limit reached
      - payment.pricing.price.generators.InterchangePlusNoDimensionPriceGenerator.out
        Max depth limit reached
      - payment.pricing.price.generators.InterchangePlusDimensionPriceGenerator.out
        Max depth limit reached
      - payment.pricing.price.generators.SubscriptionWithOveragePriceGenerator.out
        Max depth limit reached
      - payment.pricing.price.generators.TieredSeatBasedGenerator.out
        Max depth limit reached
      - payment.pricing.price.generators.TieredSeatBasedDimensionGenerator.out
        Max depth limit reached
      - payment.pricing.price.generators.UltraFrequencyNoDimensionPriceGenerator.out
        Max depth limit reached
      - payment.pricing.price.generators.UltraFrequencyDimensionPriceGenerator.out
        Max depth limit reached
      - payment.pricing.price.generators.UltraFrequencySubscriptionWithOveragePriceGenerator.out
        Max depth limit reached
      - payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.out
        Max depth limit reached
      - payment.pricing.price.generators.MaxUsageBasedDimensionPriceGenerator.out
        Max depth limit reached
      - payment.pricing.price.generators.SumUsageBasedDimensionPriceGenerator.out
        Max depth limit reached
      - payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.out
        Max depth limit reached
      - payment.pricing.price.generators.MaxUsageBasedNoDimensionPriceGenerator.out
        Max depth limit reached
      - payment.pricing.price.generators.SumUsageBasedNoDimensionPriceGenerator.out
        Max depth limit reached
      - payment.pricing.price.generators.UsageBasedVolumePriceGenerator.out
        Max depth limit reached
      - payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.out
        Max depth limit reached
    - invoiceBasedFeespayment.pricing.invoice_based_fees.InvoiceBasedFee.out[]
      Description
      The service fees for the invoice.
      - payment.pricing.invoice_based_fees.ConstantInvoiceRatioFee.out
        typestring
        Default
        constant_invoice_ratio_fee
        productIdstring
        idstring
        namestring
        descriptionstring
        lockingStatuscom.amberflo.service.common.LockingStatus.out
        lastUpdateTimeInMillisinteger<int64>
        percentsOfInvoicenumber
        minimumFeePerFullCyclenumber
  - payment.pricing.plans.generators.FlatRatePlanGenerator.out
    - idstringrequired
      Description
      Id associated with the plan.
    - billingPeriodpayment.pricing.BillingPeriod.outrequired
      Description
      Billing period of the plan: how often an invoice is generated.
      - intervalpayment.pricing.BillingPeriodInterval.out
      - intervalsCountinteger<int32>
    - planNamestringrequired
      Description
      Name of the plan. Useful for displaying to users.
    - priceGeneratorspayment.pricing.price.generators.FlatRatePriceGenerator.out[]required
      Description
      List of price generators to use in the plan. Must be strictly flat rate.
      - idstringrequired
        Description
        Id associated with the price.
      - flatRatenumberrequired
        Description
        Amount intended to be charged.
      - productItemIdstringrequired
        Description
        Product item id associated with the price.
      - lockingStatuscom.amberflo.service.common.LockingStatus.out
        Description
        Indicates if the meter can be modified or not.
      - productItemInvoiceLabelstring
        Description
        Optional product item invoice label. Used for renaming invoice items.
      - productItemPriceNamestring
        Description
        Name of the price machine. Useful for displaying to users.
      - scalarnumber
        Description
        Optional scalar for scaling usage
      - dimensionalScalarspayment.pricing.price.DimensionalScalar.out[]
        Description
        Optional scalars for scaling usage by dimensions
        dimensionConstraintMapmap<string, string>
        scalarnumber
      - usageTransformerpayment.pricing.UsageTransformer.out
        Description
        Optional usage transformer. May include just transformer id if the transformer already exists.
        idstring
        Description
        Unique identifier for a particular usage transformer.
        namestring
        Description
        Name given to the usage transformer.
        transformUsageDimensionNamestring
        Description
        Name of the dimension used to transform / scale usage.
        productItemIdstring
        Description
        Product item id associated with the usage transformer.
        dimensionsInterpolationscom.amberflo.service.common.dimensions_interpolation.DimensionsInterpolation.out[]
        Description
        List of dimension interpolations, used to derive new dimensions and their values.
        com.amberflo.service.common.dimensions_interpolation.ListNumericInterpolation.out
        Max depth limit reached
        com.amberflo.service.common.dimensions_interpolation.TableInterpolation.out
        Max depth limit reached
        com.amberflo.service.common.dimensions_interpolation.TiersInterpolation.out
        Max depth limit reached
        requiredDimensionsstring[]
        lockingStatuscom.amberflo.service.common.LockingStatus.out
        Max depth limit reached
        lastUpdateTimeInMillisinteger<int64>
      - typestring
        Description
        Type of template, automatically populated.
        Default
        flat_rate
    - descriptionstring
      Description
      Description of the plan. Useful for displaying to users.
    - invoiceBasedFeeIdsstring[]
      Description
      A set of fee ids that can calculate an invoice's cost in a custom way.
    - isDefaultboolean
      Description
      Indicates if the plan is the default plan for users.
    - lockingStatuscom.amberflo.service.common.LockingStatus.out
      Description
      Indicates if the plan can be modified or not.
    - planLevelFreeTiernumber
      Description
      Amount that user can use for free without paying on a plan level.
    - successorPlanIdstring
      Description
      Indicates if the plan has a successor. Gives the option to automatically assign a new plan for a given plan once current plan is deprecated.
    - transitionStrategypayment.pricing.SuccessorPlanTransitionStrategy.out
      Description
      Successor plan transition: whether to wait for end of billing cycle or not.
    - entitlementspayment.pricing.Entitlements.Entitlement.out[]
      Description
      A list of entitlements: Entitlement is a feature flag for a specified entitlement id or an api name.
      - idstringrequired
        Description
        Id for the Entitlement.
      - labelstring
        Description
        Label for the Entitlement.
      - apiNamestringrequired
        Description
        User-defined API Name for the Entitlement.
    - typestring
      Description
      Type of template, automatically populated.
      Default
      flat_rate
  - payment.pricing.plans.generators.PayAndGoPlanGenerator.out
    - idstringrequired
      Description
      Id associated with the plan.
    - billingPeriodpayment.pricing.BillingPeriod.outrequired
      Description
      Billing period of the plan: how often an invoice is generated.
      - intervalpayment.pricing.BillingPeriodInterval.out
        Max depth limit reached
      - intervalsCountinteger<int32>
    - planNamestringrequired
      Description
      Name of the plan. Useful for displaying to users.
    - prepaidBuyingRulespayment.pricing.prepaid.PlanPrepaidBuyingRules.outrequired
      Description
      Pay and Go prepaid credit purchasing information.
      - planFixedFeeIdsToPrepaystring[]
      - planRecurringPrepaidAmountnumber
        Description
        Recurring prepaid to purchase on every billing period on a plan level.
      - productItemRecurringPrepaidAmountpayment.pricing.prepaid.PrepaidProductItem.out[]
        Description
        Recurring prepaid to purchase on every billing period on a product item level.
        Max depth limit reached
      - walletMinPrepaidAvailablenumber
        Description
        Minimum amount that the prepaid wallet should hold. If it's below, Amberflo will automatically purchase more.
      - productItemMinPrepaidAvailablemap<string, number>
        Description
        Key: product item id. Minimum amount that prepaid cards for a product item should hold. If it's below, Amberflo will automatically purchase more.
    - priceGeneratorspayment.pricing.price.generators.UsageBasedPriceGenerator.out[]required
      Description
      List of price generators to use in the plan. Must be usage-based.
      - payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.out
        Max depth limit reached
      - payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.out
        Max depth limit reached
      - payment.pricing.price.generators.UsageBasedVolumePriceGenerator.out
        Max depth limit reached
      - payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.out
        Max depth limit reached
    - descriptionstring
      Description
      Description of the plan. Useful for displaying to users.
    - feeMapmap<string, payment.pricing.ProductPlanFee.out>
      Description
      Fixed fees to attach to product plan.
    - invoiceBasedFeeIdsstring[]
      Description
      A set of ids for invoice based fees that are added to the invoice.
    - isDefaultboolean
      Description
      Indicates if the plan is the default plan for users.
    - lockingStatuscom.amberflo.service.common.LockingStatus.out
      Description
      Indicates if the plan can be modified or not.
    - planLevelFreeTiernumber
      Description
      Amount that user can use for free without paying on a plan level.
    - successorPlanIdstring
      Description
      Indicates if the plan has a successor. Gives the option to automatically assign a new plan for a given plan once current plan is deprecated.
    - transitionStrategypayment.pricing.SuccessorPlanTransitionStrategy.out
      Description
      Successor plan transition: whether to wait for end of billing cycle or not.
    - entitlementspayment.pricing.Entitlements.Entitlement.out[]
      Description
      A list of entitlements: Entitlement is a feature flag for a specified entitlement id or an api name.
      - idstringrequired
        Description
        Id for the Entitlement.
      - labelstring
        Description
        Label for the Entitlement.
      - apiNamestringrequired
        Description
        User-defined API Name for the Entitlement.
    - typestring
      Description
      Type of template, automatically populated.
      Default
      pay_and_go
  - payment.pricing.plans.generators.UsageBasedPlanGenerator.out
    - idstringrequired
      Description
      Id associated with the plan.
    - billingPeriodpayment.pricing.BillingPeriod.outrequired
      Description
      Billing period of the plan: how often an invoice is generated.
      - Max depth limit reached
    - planNamestringrequired
      Description
      Name of the plan. Useful for displaying to users.
    - priceGeneratorspayment.pricing.price.generators.UsageBasedPriceGenerator.out[]required
      Description
      List of price generators to use in the plan. Must be usage-based.
      - payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.out
        Max depth limit reached
      - payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.out
        Max depth limit reached
      - payment.pricing.price.generators.UsageBasedVolumePriceGenerator.out
        Max depth limit reached
      - payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.out
        Max depth limit reached
    - descriptionstring
      Description
      Description of the plan. Useful for displaying to users.
    - invoiceBasedFeeIdsstring[]
      Description
      A set of fee ids that can calculate an invoice's cost in a custom way.
    - isDefaultboolean
      Description
      Indicates if the plan is the default plan for users.
    - lockingStatuscom.amberflo.service.common.LockingStatus.out
      Description
      Indicates if the plan can be modified or not.
      - Max depth limit reached
    - planLevelFreeTiernumber
      Description
      Amount that user can use for free without paying on a plan level.
    - successorPlanIdstring
      Description
      Indicates if the plan has a successor. Gives the option to automatically assign a new plan for a given plan once current plan is deprecated.
    - transitionStrategypayment.pricing.SuccessorPlanTransitionStrategy.out
      Description
      Successor plan transition: whether to wait for end of billing cycle or not.
      - Max depth limit reached
    - entitlementspayment.pricing.Entitlements.Entitlement.out[]
      Description
      A list of entitlements: Entitlement is a feature flag for a specified entitlement id or an api name.
      - Max depth limit reached
    - typestring
      Description
      Type of template, automatically populated.
      Default
      pure_usage_based
  - payment.pricing.plans.generators.SeatBasedPlanGenerator.out
    - Max depth limit reached
  - payment.pricing.plans.generators.SubscriptionPlanGenerator.out
    - Max depth limit reached
- planCurrencystring
  Example
  USD
  Description
  The customized currency for the plan in ISO 4217 format.
- realTimePricingboolean

curl

curl --request POST \
     --url https://app.amberflo.io/payments/pricing/amberflo/account-pricing/product-plan-extension \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://app.amberflo.io/payments/pricing/amberflo/account-pricing/product-plan-extension", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://app.amberflo.io/payments/pricing/amberflo/account-pricing/product-plan-extension")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://app.amberflo.io/payments/pricing/amberflo/account-pricing/product-plan-extension"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Successful request
{
  "id": "",
  "productId": "",
  "productItemPriceIdsMap": "",
  "billingPeriod": {
    "interval": "",
    "intervalsCount": ""
  },
  "planLevelFreeTier": 0,
  "invoiceBasedFeeIds": [
    ""
  ],
  "planMinimumPayment": 0,
  "minimumPaymentGranularity": "",
  "productPlanName": "",
  "description": "",
  "lastUpdateTimeInMillis": "",
  "feeMap": "",
  "entitlements": [
    {
      "id": "",
      "label": "",
      "apiName": ""
    }
  ],
  "lockingStatus": "",
  "isDefault": false,
  "successorPlanId": "",
  "transitionStrategy": "",
  "type": "",
  "prepaidBuyingRules": {
    "planFixedFeeIdsToPrepay": [
      ""
    ],
    "planRecurringPrepaidAmount": 0,
    "productItemRecurringPrepaidAmount": [
      {
        "productItemId": "",
        "prepaidAmount": 0
      }
    ],
    "walletMinPrepaidAvailable": 0,
    "productItemMinPrepaidAvailable": ""
  },
  "planGenerator": {},
  "planCurrency": "USD",
  "realTimePricing": false
}

Add an existing product item price to a product plan.