--- title: Query a plan catalog by id slug: amberflo-api/query-a-plan-catalog-by-id docTags: createdAt: 2024-11-07T15:10:16.977Z --- { "id": "INN6ys8RsthGPfKbX8Tf-", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://app.amberflo.io/payments/pricing/amberflo/account-pricing/plan-catalog", "servers": [ { "url": "https://app.amberflo.io/payments/pricing/amberflo/account-pricing/plan-catalog" } ], "name": "Query a plan catalog by id", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKey", "name": "X-API-KEY", "kind": "optional", "type": "apiKey", "in": "header" } ] }, "responses": [ { "statusCode": "200", "description": "Successful request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "payment.pricing.plans.detailed.DetailedPlanCatalog.out", "schema": [ { "name": "id", "kind": "optional", "type": "string", "example": "" }, { "name": "detailedPlanCatalogItems", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.detailed.DetailedPlanCatalogItem.out", "customType": "payment.pricing.plans.detailed.DetailedPlanCatalogItem.out[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "Unique id to identify a particular plan catalog item", "example": "" }, { "name": "planId", "kind": "required", "type": "string", "description": "The product plan id associated with this plan catalog item", "example": "" }, { "name": "name", "kind": "required", "type": "string", "description": "Name given to the plan catalog item", "example": "" }, { "name": "entitlements", "kind": "required", "type": "array", "description": "Entitlements (such as services or resources) that are tied to this plan catalog item", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "prepaidPaymentsOptions", "kind": "required", "type": "array", "description": "Prepaid payment options that the customer may choose from", "modelRef": "#/components/schemas/payment.pricing.plans.catalog.PrepaidPaymentOption.out", "customType": "payment.pricing.plans.catalog.PrepaidPaymentOption.out[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "Unique id associated to the prepaid payment option", "example": "" }, { "name": "prepaidPromotionId", "kind": "optional", "type": "string", "description": "The id of the prepaid promotion that this payment option uses", "example": "" }, { "name": "price", "kind": "required", "type": "number", "description": "Price associated with the prepaid payment option", "example": "" }, { "name": "discountReflected", "kind": "optional", "type": "number", "description": "The discount, if any, reflected for this prepaid payment option", "example": "" }, { "name": "expirationInDays", "kind": "optional", "type": "integer", "example": 0 }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional description for the prepaid payment option", "example": "" }, { "name": "futureMoney", "kind": "optional", "type": "number", "description": "An optional value to indicate the worth associated with the prepaid payment option", "example": "" }, { "name": "futureUsage", "kind": "optional", "type": "object", "description": "An optional value to indicate the worth, in units of usage, associated with the prepaid payment option", "modelRef": "#/components/schemas/payment.pricing.plans.catalog.FutureUsage.out", "customType": "payment.pricing.plans.catalog.FutureUsage.out", "schema": [ { "name": "itemId", "kind": "optional", "type": "string", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" } ] } ] }, { "name": "trialPeriodInDays", "kind": "required", "type": "number", "description": "Denotes the trial period for this plan catalog item in days", "example": "" }, { "name": "trialPeriodPlanId", "kind": "optional", "type": "string", "description": "The promotion id that is tied to the trial period", "example": "" }, { "name": "isDefault", "kind": "optional", "type": "boolean", "description": "Optional field to mark catalog item as default, false by default", "example": "" }, { "name": "isCreditCardRequired", "kind": "required", "type": "boolean", "description": "Field to indicate if credit card is required", "example": "" }, { "name": "productPlan", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.ProductPlan.out", "customType": "payment.pricing.ProductPlan.out", "schema": [ { "name": "id", "kind": "optional", "type": "string", "example": "" }, { "name": "productId", "kind": "optional", "type": "string", "example": "" }, { "name": "productItemPriceIdsMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "billingPeriod", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.BillingPeriod.out", "customType": "payment.pricing.BillingPeriod.out", "schema": [ { "name": "interval", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.BillingPeriodInterval.out", "customType": "payment.pricing.BillingPeriodInterval.out", "schema": [] }, { "name": "intervalsCount", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "planLevelFreeTier", "kind": "optional", "type": "number", "example": "" }, { "name": "invoiceBasedFeeIds", "kind": "optional", "type": "array", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "planMinimumPayment", "kind": "optional", "type": "number", "description": "A minimum payment for the entire plan.", "example": "" }, { "name": "minimumPaymentGranularity", "kind": "optional", "type": "string", "description": "Determines the granularity of the payment. only 'hourly' and 'entire_invoice_period' are allowed, currently.", "modelRef": "#/components/schemas/payment.pricing.price.UsageGranularity.out", "customType": "payment.pricing.price.UsageGranularity.out", "schema": [] }, { "name": "productPlanName", "kind": "optional", "type": "string", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "example": 0 }, { "name": "feeMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "entitlements", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.pricing.Entitlements.Entitlement.out", "customType": "payment.pricing.Entitlements.Entitlement.out[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Id for the Entitlement.", "example": "" }, { "name": "label", "kind": "optional", "type": "string", "description": "Label for the Entitlement.", "example": "" }, { "name": "apiName", "kind": "required", "type": "string", "description": "User-defined API Name for the Entitlement.", "example": "" } ] }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "isDefault", "kind": "optional", "type": "boolean", "example": "" }, { "name": "successorPlanId", "kind": "optional", "type": "string", "example": "" }, { "name": "transitionStrategy", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.SuccessorPlanTransitionStrategy.out", "customType": "payment.pricing.SuccessorPlanTransitionStrategy.out", "schema": [] }, { "name": "type", "kind": "optional", "type": "string", "example": "" }, { "name": "prepaidBuyingRules", "kind": "optional", "type": "object", "description": "Rules for the prepaid", "modelRef": "#/components/schemas/payment.pricing.prepaid.PlanPrepaidBuyingRules.out", "customType": "payment.pricing.prepaid.PlanPrepaidBuyingRules.out", "schema": [ { "name": "planFixedFeeIdsToPrepay", "kind": "optional", "type": "array", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "planRecurringPrepaidAmount", "kind": "optional", "type": "number", "description": "Recurring prepaid to purchase on every billing period on a plan level.", "example": "" }, { "name": "productItemRecurringPrepaidAmount", "kind": "optional", "type": "array", "description": "Recurring prepaid to purchase on every billing period on a product item level.", "modelRef": "#/components/schemas/payment.pricing.prepaid.PrepaidProductItem.out", "customType": "payment.pricing.prepaid.PrepaidProductItem.out[]", "schema": [ { "name": "productItemId", "kind": "optional", "type": "string", "description": "Product item id that is associated with amount of prepaid.", "example": "" }, { "name": "prepaidAmount", "kind": "optional", "type": "number", "description": "Prepaid amount that is associated with the object.", "example": "" } ] }, { "name": "walletMinPrepaidAvailable", "kind": "optional", "type": "number", "description": "Minimum amount that the prepaid wallet should hold. If it's below, Amberflo will automatically purchase more.", "example": "" }, { "name": "productItemMinPrepaidAvailable", "kind": "optional", "type": "map", "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.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "planGenerator", "kind": "optional", "type": "object", "description": "The template of the plan generator", "modelRef": "#/components/schemas/payment.pricing.plans.generators.PlanGenerator.out", "customType": "payment.pricing.plans.generators.PlanGenerator.out", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.plans.generators.CustomPlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.CustomPlanGenerator.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "Type of template, automatically populated.", "example": "", "default": "custom_pricing_plan" }, { "name": "id", "kind": "required", "type": "string", "description": "Id associated with the plan.", "example": "" }, { "name": "billingPeriod", "kind": "required", "type": "object", "description": "Billing period of the plan: how often an invoice is generated.", "modelRef": "#/components/schemas/payment.pricing.BillingPeriod.out", "customType": "payment.pricing.BillingPeriod.out", "schema": [ { "name": "interval", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.BillingPeriodInterval.out", "customType": "payment.pricing.BillingPeriodInterval.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "intervalsCount", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "planLevelFreeTier", "kind": "optional", "type": "number", "description": "Amount that user can use for free without paying on a plan level.", "example": "" }, { "name": "invoiceBasedFeeIds", "kind": "optional", "type": "array", "description": "A set of fee ids that can calculate an invoice's cost in a custom way.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "planMinimumPayment", "kind": "optional", "type": "number", "description": "A minimum payment for the entire plan.", "example": "" }, { "name": "minimumPaymentGranularity", "kind": "optional", "type": "string", "description": "Determines the granularity of the payment. only 'hourly' and 'entire_invoice_period' are allowed, currently.", "modelRef": "#/components/schemas/payment.pricing.price.UsageGranularity.out", "customType": "payment.pricing.price.UsageGranularity.out", "schema": [] }, { "name": "planName", "kind": "required", "type": "string", "description": "Name of the plan. Useful for displaying to users.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Description of the plan. Useful for displaying to users.", "example": "" }, { "name": "feeMap", "kind": "optional", "type": "map", "description": "Fee Id to fee that maps to product plan fee.", "example": "", "customType": "map", "schema": [] }, { "name": "entitlements", "kind": "optional", "type": "array", "description": "A list of entitlements: Entitlement is a feature flag for a specified entitlement id or an api name.", "modelRef": "#/components/schemas/payment.pricing.Entitlements.Entitlement.out", "customType": "payment.pricing.Entitlements.Entitlement.out[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Id for the Entitlement.", "example": "" }, { "name": "label", "kind": "optional", "type": "string", "description": "Label for the Entitlement.", "example": "" }, { "name": "apiName", "kind": "required", "type": "string", "description": "User-defined API Name for the Entitlement.", "example": "" } ] }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Indicates if the plan can be modified or not.", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "isDefault", "kind": "optional", "type": "boolean", "description": "Indicates if the plan is the default plan for users.", "example": "" }, { "name": "successorPlanId", "kind": "optional", "type": "string", "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.", "example": "" }, { "name": "transitionStrategy", "kind": "optional", "type": "string", "description": "Successor plan transition: whether to wait for end of billing cycle or not.", "modelRef": "#/components/schemas/payment.pricing.SuccessorPlanTransitionStrategy.out", "customType": "payment.pricing.SuccessorPlanTransitionStrategy.out", "schema": [] }, { "name": "prepaidBuyingRules", "kind": "optional", "type": "object", "description": "Rules for the prepaid", "modelRef": "#/components/schemas/payment.pricing.prepaid.PlanPrepaidBuyingRules.out", "customType": "payment.pricing.prepaid.PlanPrepaidBuyingRules.out", "schema": [ { "name": "planFixedFeeIdsToPrepay", "kind": "optional", "type": "array", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "planRecurringPrepaidAmount", "kind": "optional", "type": "number", "description": "Recurring prepaid to purchase on every billing period on a plan level.", "example": "" }, { "name": "productItemRecurringPrepaidAmount", "kind": "optional", "type": "array", "description": "Recurring prepaid to purchase on every billing period on a product item level.", "modelRef": "#/components/schemas/payment.pricing.prepaid.PrepaidProductItem.out", "customType": "payment.pricing.prepaid.PrepaidProductItem.out[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "walletMinPrepaidAvailable", "kind": "optional", "type": "number", "description": "Minimum amount that the prepaid wallet should hold. If it's below, Amberflo will automatically purchase more.", "example": "" }, { "name": "productItemMinPrepaidAvailable", "kind": "optional", "type": "map", "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.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "planCurrency", "kind": "optional", "type": "string", "description": "The customized currency for the plan in ISO 4217 format.", "example": "USD" }, { "name": "priceGenerators", "kind": "required", "type": "object", "description": "List of price generators to use in the plan. Can be any price generator.", "modelRef": "#/components/schemas/payment.pricing.price.generators.PriceGenerator.out", "customType": "payment.pricing.price.generators.PriceGenerator.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.price.generators.CostPlusDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.CostPlusDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.CostPlusNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.CostPlusNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.FlatRatePriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.FlatRatePriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.FlatRateWithOveragesPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.FlatRateWithOveragesPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.InterchangePlusNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.InterchangePlusNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.InterchangePlusDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.InterchangePlusDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.SubscriptionWithOveragePriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.SubscriptionWithOveragePriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.TieredSeatBasedGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.TieredSeatBasedGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.TieredSeatBasedDimensionGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.TieredSeatBasedDimensionGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UltraFrequencyNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UltraFrequencyNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UltraFrequencyDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UltraFrequencyDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UltraFrequencySubscriptionWithOveragePriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UltraFrequencySubscriptionWithOveragePriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.MaxUsageBasedDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.MaxUsageBasedDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.SumUsageBasedDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.SumUsageBasedDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.MaxUsageBasedNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.MaxUsageBasedNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.SumUsageBasedNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.SumUsageBasedNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedVolumePriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedVolumePriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "invoiceBasedFees", "kind": "optional", "type": "object", "description": "The service fees for the invoice.", "modelRef": "#/components/schemas/payment.pricing.invoice_based_fees.InvoiceBasedFee.out", "customType": "payment.pricing.invoice_based_fees.InvoiceBasedFee.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.invoice_based_fees.ConstantInvoiceRatioFee.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.invoice_based_fees.ConstantInvoiceRatioFee.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] }, { "name": "payment.pricing.plans.generators.FlatRatePlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.FlatRatePlanGenerator.out", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Id associated with the plan.", "example": "" }, { "name": "billingPeriod", "kind": "required", "type": "object", "description": "Billing period of the plan: how often an invoice is generated.", "modelRef": "#/components/schemas/payment.pricing.BillingPeriod.out", "customType": "payment.pricing.BillingPeriod.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "planName", "kind": "required", "type": "string", "description": "Name of the plan. Useful for displaying to users.", "example": "" }, { "name": "priceGenerators", "kind": "required", "type": "array", "description": "List of price generators to use in the plan. Must be strictly flat rate.", "modelRef": "#/components/schemas/payment.pricing.price.generators.FlatRatePriceGenerator.out", "customType": "payment.pricing.price.generators.FlatRatePriceGenerator.out[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "description", "kind": "optional", "type": "string", "description": "Description of the plan. Useful for displaying to users.", "example": "" }, { "name": "invoiceBasedFeeIds", "kind": "optional", "type": "array", "description": "A set of fee ids that can calculate an invoice's cost in a custom way.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "isDefault", "kind": "optional", "type": "boolean", "description": "Indicates if the plan is the default plan for users.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Indicates if the plan can be modified or not.", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "planLevelFreeTier", "kind": "optional", "type": "number", "description": "Amount that user can use for free without paying on a plan level.", "example": "" }, { "name": "successorPlanId", "kind": "optional", "type": "string", "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.", "example": "" }, { "name": "transitionStrategy", "kind": "optional", "type": "string", "description": "Successor plan transition: whether to wait for end of billing cycle or not.", "modelRef": "#/components/schemas/payment.pricing.SuccessorPlanTransitionStrategy.out", "customType": "payment.pricing.SuccessorPlanTransitionStrategy.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "entitlements", "kind": "optional", "type": "array", "description": "A list of entitlements: Entitlement is a feature flag for a specified entitlement id or an api name.", "modelRef": "#/components/schemas/payment.pricing.Entitlements.Entitlement.out", "customType": "payment.pricing.Entitlements.Entitlement.out[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "type", "kind": "optional", "type": "string", "description": "Type of template, automatically populated.", "example": "", "default": "flat_rate" } ] }, { "name": "payment.pricing.plans.generators.PayAndGoPlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.PayAndGoPlanGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.plans.generators.UsageBasedPlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.UsageBasedPlanGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.plans.generators.SeatBasedPlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.SeatBasedPlanGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.plans.generators.SubscriptionPlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.SubscriptionPlanGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "planCurrency", "kind": "optional", "type": "string", "description": "The customized currency for the plan in ISO 4217 format.", "example": "USD" }, { "name": "realTimePricing", "kind": "optional", "type": "boolean", "example": "" } ] }, { "name": "totalFixPrice", "kind": "optional", "type": "number", "description": "fixed price of the catalog item for a billing period, if any exists", "example": "" }, { "name": "billingPeriod", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.BillingPeriod.out", "customType": "payment.pricing.BillingPeriod.out", "schema": [ { "name": "interval", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.BillingPeriodInterval.out", "customType": "payment.pricing.BillingPeriodInterval.out", "schema": [] }, { "name": "intervalsCount", "kind": "optional", "type": "integer", "example": 0 } ] } ] }, { "name": "customPlanCatalogItems", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.catalog.CustomPlanCatalogItem.out", "customType": "payment.pricing.plans.catalog.CustomPlanCatalogItem.out[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "Unique id to identify a particular custom plan catalog item", "example": "" }, { "name": "name", "kind": "required", "type": "string", "description": "Name given to the custom plan catalog item", "example": "" }, { "name": "entitlements", "kind": "optional", "type": "array", "description": "Entitlements (such as services or resources) that are tied to this plan catalog item", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] } ], "modelRef": "#/components/schemas/payment.pricing.plans.detailed.DetailedPlanCatalog.out", "isExpanded": true } ] } ], "examples": { "languages": [ { "id": "nYLnSOozIkZhgKJSaHIKY", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://app.amberflo.io/payments/pricing/amberflo/account-pricing/plan-catalog \\\n --header 'accept: application/json'" }, { "id": "iFDqfP6PxyYs386D2E7nN", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://app.amberflo.io/payments/pricing/amberflo/account-pricing/plan-catalog\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "n_dS0iyZJeL8cmTgnHbSr", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://app.amberflo.io/payments/pricing/amberflo/account-pricing/plan-catalog\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "QdnYGdW1fsFdZZqBhY7XD", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/payments/pricing/amberflo/account-pricing/plan-catalog\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "nYLnSOozIkZhgKJSaHIKY" }, "results": { "languages": [ { "id": "dIGoDvAoudQKQ_UeIFY1V", "language": "200", "code": "// Successful request\n{\n \"id\": \"\",\n \"detailedPlanCatalogItems\": [\n {\n \"id\": \"\",\n \"planId\": \"\",\n \"name\": \"\",\n \"entitlements\": [\n \"\"\n ],\n \"prepaidPaymentsOptions\": [\n {\n \"id\": \"\",\n \"prepaidPromotionId\": \"\",\n \"price\": 0,\n \"discountReflected\": 0,\n \"expirationInDays\": \"\",\n \"description\": \"\",\n \"futureMoney\": 0,\n \"futureUsage\": {\n \"itemId\": \"\",\n \"description\": \"\"\n }\n }\n ],\n \"trialPeriodInDays\": 0,\n \"trialPeriodPlanId\": \"\",\n \"isDefault\": false,\n \"isCreditCardRequired\": false,\n \"productPlan\": {\n \"id\": \"\",\n \"productId\": \"\",\n \"productItemPriceIdsMap\": \"\",\n \"billingPeriod\": {\n \"interval\": \"\",\n \"intervalsCount\": \"\"\n },\n \"planLevelFreeTier\": 0,\n \"invoiceBasedFeeIds\": [\n \"\"\n ],\n \"planMinimumPayment\": 0,\n \"minimumPaymentGranularity\": \"\",\n \"productPlanName\": \"\",\n \"description\": \"\",\n \"lastUpdateTimeInMillis\": \"\",\n \"feeMap\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"label\": \"\",\n \"apiName\": \"\"\n }\n ],\n \"lockingStatus\": \"\",\n \"isDefault\": false,\n \"successorPlanId\": \"\",\n \"transitionStrategy\": \"\",\n \"type\": \"\",\n \"prepaidBuyingRules\": {\n \"planFixedFeeIdsToPrepay\": [\n \"\"\n ],\n \"planRecurringPrepaidAmount\": 0,\n \"productItemRecurringPrepaidAmount\": [\n {\n \"productItemId\": \"\",\n \"prepaidAmount\": 0\n }\n ],\n \"walletMinPrepaidAvailable\": 0,\n \"productItemMinPrepaidAvailable\": \"\"\n },\n \"planGenerator\": {},\n \"planCurrency\": \"USD\",\n \"realTimePricing\": false\n },\n \"totalFixPrice\": 0,\n \"billingPeriod\": {\n \"interval\": \"\",\n \"intervalsCount\": \"\"\n }\n }\n ],\n \"customPlanCatalogItems\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"entitlements\": [\n \"\"\n ]\n }\n ]\n}" } ], "selectedLanguageId": "dIGoDvAoudQKQ_UeIFY1V" } }, "children": [ { "text": "" } ] }