Change term end

Idempotency Supported

Use this endpoint to adjust when a subscription's current term or trial ends without altering the plan or billing frequency. It is helpful when you need to align renewals to a specific calendar date or extend a trial. Future renewals will follow the new date, keeping the subscription cadence intact.

Prerequisites & Constraints

Subscriptions must be in one of the following status values: in_trial, active, non_renewing.

Impacts

Subscription

Based on the subscription's status, the following updates are made:

If the status is in_trial, the trial_end is set to the new date.
If the status is active, the current_term_end is set to the new date.
If the status is non_renewing, the upcoming cancellation date is set to the new date.

Invoices and Credit Notes

The API can generate unbilled charges, invoice, or credit notes. You can control the behaviour using prorate and invoice_immediately parameters. To preview invoices, credits, and dates, use the Change term end estimate endpoint.

Advance Charges

If there are advance charges, then credit notes are issued for the unused portion of the service period.

Scheduled Pause

If the subscription is scheduled to pause at the end of the current term, the pause date is updated to match the new term end date.

Ramps

If subscription ramps are present, this operation moves them to the draft state. Update and reschedule the ramps as needed to keep them in sync.

Implementation Notes

The request fails with invalid_state if the subscription is not in one of the trial, active, or non_renewing states. Validate the status before invoking this API.

Sample Request

URL Format

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

Input Parameters

term_ends_at

required, timestamp(UTC) in seconds

The time at which the current term should end for this subscription. The value must be a date in the future, i.e. later than current time. The value must not be the same as next_billing_at .

prorate

optional, boolean

Applicable for active / non_renewing subscriptions. If specified as true prorated charges / credits will be added during this operation.

invoice_immediately

optional, boolean

If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to unbilled charges. The default value is as per the site settings .

Note: invoice_immediately only affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.

Returns

subscriptionSubscription object

Resource object representing subscription

customerCustomer object

Resource object representing customer

cardCard object

Resource object representing card

invoiceInvoice object

Resource object representing invoice

unbilled_chargesoptional

Resource object representing unbilled_charge

credit_notesoptional

Resource object representing credit_note