add_subscription_rate_plan_charge
Add a billing charge to a subscription rate plan by specifying pricing models, billing cycles, and charge types for recurring or one-time fees.
Instructions
Add a rate plan charge to a subscription rate plan. POST .../rateplan-charges. Required: subscriptionId, ratePlanId, quantity, name, category (physical|digital), chargeModel (flatFeePricing|perUnitPricing|tieredPricing|volumePricing), billCycleType (chargeTriggerDay|defaultFromCustomer|specificDayOfMonth|specificDayOfWeek|specificMonthOfYear|subscriptionStartDay|subscriptionFreeTrial), chargeTier array (each: currency, price required; optional startingUnit, endingUnit, priceFormat, tier), chargeType (oneTime|recurring|usage), endDateCondition (subscriptionEnd|fixedPeriod), taxable (boolean), weight. When chargeType is recurring, billingPeriodAlignment and specificBillingPeriod are also required. Optional: productRatePlanChargeId, billingPeriod, billingTiming.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| subscriptionId | Yes | Subscription ID (required) | |
| ratePlanId | Yes | Subscription rate plan ID (required) | |
| quantity | Yes | Quantity (required) | |
| name | Yes | Charge name (required) | |
| category | Yes | Required. physical or digital | |
| chargeModel | Yes | Required. flatFeePricing|perUnitPricing|tieredPricing|volumePricing | |
| billCycleType | Yes | Required. chargeTriggerDay|defaultFromCustomer|specificDayOfMonth|specificDayOfWeek|specificMonthOfYear|subscriptionStartDay|subscriptionFreeTrial | |
| chargeTier | Yes | Required. Array of tiers: currency (required), price (required, e.g. cents), optional startingUnit, endingUnit, priceFormat, tier | |
| chargeType | Yes | Required. oneTime|recurring|usage | |
| endDateCondition | Yes | Required. subscriptionEnd or fixedPeriod | |
| taxable | Yes | Required. Whether the charge is taxable | |
| weight | Yes | Required. Weight or null. Numeric values are converted to integer by multiplying by 100 (e.g. 32.75 -> 3275). | |
| productRatePlanChargeId | No | Product rate plan charge ID to reference | |
| billingPeriod | No | day, week, month, year | |
| billingTiming | No | inAdvance, inArrears | |
| billingPeriodAlignment | No | Required when chargeType is recurring. Valid values: alignToCharge, alignToSubscriptionStart, alignToTermStart | |
| specificBillingPeriod | No | Required when chargeType is recurring |