Introducing the Better Auth Chargebee plugin: Use it to handle subscriptions, billing, and auth seamlessly.
Chargebeechargebee API

Extend Subscription

Idempotency Supported

This API generates a hosted page URL to extend the billing cycle of a subscription.

Use one of the following methods to open the hosted page:

  • In-app modal: Use Chargebee.js openCheckout() to open the hosted page in a modal popup in your website or application.
  • Standalone page: Redirect the customer to the hosted page url.

Do not embed the hosted page in your own iframe.

Sample Request

Sample Result[JSON]

URL Format

POST https://[site].chargebee.com/api/v2/hosted_pages/extend_subscription

Input Parameters

expiry
optional, integer, min=1, max=500

Expiry (in days) for the link generated. No expiry will be set if this is not specified.

billing_cycle
optional, integer, min=1

The number of billing cycles by which the subscription should be extended.

Default behavior

  • If the subscription's plan has billing_cycles set, that value is used.
  • If the plan's billing cycles attribute is not set, 1 is used.
subscription
Parameters for subscription
pass parameters as subscription[<param name>]

Returns

hosted_page
Hosted page object
Resource object representing hosted_page