Create a ProductPlan using a product plan generator

1min

POST
https://app.amberflo.io/payments/pricing/amberflo/account-pricing/product-plans/template/flat_rate
Authentication
X-API-KEY
apiKey
Body Parameters
body
payment.pricing.plans.generators.FlatRatePlanGenerator.in
id
string
*
billingPeriod
payment.pricing.BillingPeriod.in
*
planName
string
*
priceGenerators
payment.pricing.price.generators.FlatRatePriceGenerator.in[]
*
description
string
invoiceBasedFeeIds
string[]
isDefault
boolean
lockingStatus
com.amberflo.service.common.LockingStatus.in
planLevelFreeTier
number
successorPlanId
string
transitionStrategy
payment.pricing.SuccessorPlanTransitionStrategy.in
entitlements
payment.pricing.Entitlements.Entitlement.in[]
type
string
Responses
200
Successful request
payment.pricing.ProductPlan.out
id
string
productId
string
productItemPriceIdsMap
map<string, string>
billingPeriod
payment.pricing.BillingPeriod.out
planLevelFreeTier
number
invoiceBasedFeeIds
string[]
planMinimumPayment
number
minimumPaymentGranularity
payment.pricing.price.UsageGranularity.out
productPlanName
string
description
string
lastUpdateTimeInMillis
integer<int64>
feeMap
map<string, payment.pricing.ProductPlanFee.out>
entitlements
payment.pricing.Entitlements.Entitlement.out[]
lockingStatus
com.amberflo.service.common.LockingStatus.out
isDefault
boolean
successorPlanId
string
transitionStrategy
payment.pricing.SuccessorPlanTransitionStrategy.out
type
string
prepaidBuyingRules
payment.pricing.prepaid.PlanPrepaidBuyingRules.out
planGenerator
payment.pricing.plans.generators.PlanGenerator.out
One Of
payment.pricing.plans.generators.CustomPlanGenerator.out 
planCurrency
string
realTimePricing
boolean
﻿
﻿

Updated 07 Nov 2024

Did this page help you?

Create a ProductPlan using a product plan generator