update_subscription_rate_plan_charge
Modify subscription rate plan charges by updating quantity, pricing model, billing cycle, and charge details to adjust recurring billing structures.
Instructions
Update a rate plan charge on a subscription. PUT /subscriptions/{subscriptionId}/rateplan-charges/{chargeId}. Required: subscriptionId, chargeId, quantity, name, chargeModel (flatFeePricing|perUnitPricing|tieredPricing|volumePricing), billCycleType, chargeTier (array: currency, price required). For price, you can pass a string dollars '41.00' or integer cents 4100 – the tool always sends cents to the API (same logic as create_invoice detail.amount). Also required: chargeType (oneTime|recurring|usage), endDateCondition (subscriptionEnd|fixedPeriod), taxable (boolean), weight. When chargeType is recurring, billingPeriodAlignment is also required. Optional: billingPeriod, billingTiming, specificBillingPeriod.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| subscriptionId | Yes | Subscription ID (required) | |
| chargeId | Yes | Subscription rate plan charge ID (required) | |
| quantity | Yes | Quantity (required) | |
| name | Yes | Charge name (required) | |
| 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 as '41.00' (dollars) or 4100 (cents); tool always sends cents to API), 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 (integer) | |
| billingPeriod | No | day, week, month, year | |
| billingTiming | No | inAdvance, inArrears | |
| billingPeriodAlignment | No | Required when chargeType is recurring. alignToCharge, alignToSubscriptionStart, alignToTermStart | |
| specificBillingPeriod | No | Specific billing period |