create_product_rate_plan_charge
Add pricing charges to subscription rate plans in Rebillia's billing system. Define one-time, recurring, or usage-based fees with various pricing models and billing cycles for e-commerce subscriptions.
Instructions
Create a rate plan charge. POST /product-rateplan-charges. Required: ratePlanId (rate plan reference, URI: /product-rateplans/{ratePlanId}), name, chargeType (oneTime|recurring|usage), chargeModel (flatFeePricing|perUnitPricing|tieredPricing|volumePricing), billCycleType, category (physical|digital), chargeTier (array of {currency ex. 'USD', price in cents, optional startingUnit, endingUnit, priceFormat, tier}), taxable, weight. Optional: billingPeriod (day|week|month|year), billingTiming (inAdvance|inArrears), description, etc.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ratePlanId | Yes | Rate plan ID (URI: /product-rateplans/{ratePlanId}) | |
| name | Yes | Charge name | |
| chargeType | Yes | oneTime, recurring, or usage | |
| chargeModel | Yes | flatFeePricing, perUnitPricing, tieredPricing, or volumePricing | |
| billCycleType | Yes | Bill cycle type (e.g. chargeTriggerDay, specificDayOfMonth) | |
| category | Yes | physical or digital | |
| chargeTier | Yes | Array of {currency, price, optional startingUnit, endingUnit, priceFormat, tier} | |
| taxable | Yes | Whether taxable | |
| weight | Yes | Weight (integer) | |
| description | No | Description | |
| billingPeriod | No | day, week, month, or year (required if chargeType recurring) | |
| billingTiming | No | inAdvance or inArrears (required if chargeType recurring) | |
| billingPeriodAlignment | No | alignToCharge, alignToSubscriptionStart, alignToTermStart | |
| specificBillingPeriod | No | Specific billing period | |
| allowChangeQuantity | No | Allow change quantity | |
| billCycleDay | No | 1-31 when billCycleType specificDayOfMonth | |
| weeklyBillCycleDay | No | sunday..saturday when billCycleType specificDayOfWeek | |
| monthlyBillCycleYear | No | 1-12 when billCycleType specificMonthOfYear | |
| endDateCondition | Yes | subscriptionEnd or fixedPeriod (required) | |
| isFreeShipping | No | Free shipping | |
| maxQuantity | No | Max quantity | |
| minQuantity | No | Min quantity | |
| quantity | No | Quantity | |
| listPriceBase | No | perMonth, perBillingPeriod, or perWeek |