ChargebeeAPI

Add charge at term end

Idempotency Supported
Try in API Explorer

Adds a one time charge to the 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 a charge 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}/add_charge_at_term_end

Input Parameters

amount
optional, in cents, min=1

The amount to be charged. The unit depends on the type of currency .

description
required, string, max chars=250

Description for this charge.

amount_in_decimal
optional, string, max chars=39

The decimal representation of the amount for the one-time charge. Provide the value in major units of the currency. Can be provided only when multi-decimal pricing is enabled.

avalara_sale_type
optional, enumerated string

Indicates the type of sale carried out. This is applicable only if you use Chargebee's AvaTax for Communications integration.

Possible Enum Values
wholesale

Transaction is a sale to another company that will resell your product or service to another consumer

retail

Transaction is a sale to an end user

consumed

Transaction is for an item that is consumed directly

vendor_use

Transaction is for an item that is subject to vendor use tax

avalara_transaction_type
optional, integer

Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use Chargebee's AvaTax for Communications integration.

avalara_service_type
optional, integer

Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use Chargebee's AvaTax for Communications integration.

date_from
optional, timestamp(UTC) in seconds

The time when the service period for the charge starts.

date_to
optional, timestamp(UTC) in seconds

The time when the service period for the charge ends.

Returns

estimateEstimate object
Resource object representing estimate