ChargebeeAPI

Charge addon at term end

Idempotency Supported

Adds a "non-recurring addon" charge to a subscription which will be added to the invoice generated at the end of the current term. If there are any applicable coupons in the subscription, an appropriate discount will be applied.

To collect the charges for the non-recurring addon immediately, use this API.

If any subscription changes happen before the end of the current term, these charges will be collected along with it.

Sample Request

URL Format

POST https://[site].chargebee.com/api/v2/subscriptions/{subscription-id}/charge_addon_at_term_end

Input Parameters

addon_id
required, string, max chars=100

The ID of the non-recurring addon to be charged.

addon_quantity
optional, integer, min=1

The number of addon units to be charged. Mandatory for quantity based addons.

addon_unit_price
optional, in cents, min=0

Amount that will override the Addon's default price. The unit depends on the type of currency .

addon_quantity_in_decimal
optional, string, max chars=33

The decimal representation of the quantity of the non-recurring addon. Provide the value in major units of the currency. Must be provided when the addon is quantity-based. This parameter can only be passed when multi-decimal pricing is enabled.

addon_unit_price_in_decimal
optional, string, default=Addon Amount in Decimal, max chars=39

When price overriding is enabled for the site, the price or per-unit price of the non-recurring addon can be set here. The value set for the addon is used by default. Provide the value as a decimal string in major units of the currency. This parameter can only be passed when multi-decimal pricing is enabled.

date_from
optional, timestamp(UTC) in seconds

The time when the service period for the addon starts.

date_to
optional, timestamp(UTC) in seconds

The time when the service period for the addon ends.

Returns

estimateEstimate object
Resource object representing estimate