Retrieve with scheduled changes

Try in API Explorer

Note If the ramps feature is enabled and there is more than one ramp on a subscription, this API will return the subscription with the upcoming ramp applied.

Retrieves a subscription with the scheduled changes applied.
Note: Only the following attributes are changed

item_id
item_price_id
billing_period
billing_period_unit
remaining_billing_cycles
coupons Other attributes such as status ,next_billing_at are not changed and will reflect the current subscription values.

Sample Request

URL Format

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

Returns

subscriptionSubscription object

Resource object representing subscription

customerCustomer object

Resource object representing customer

cardCard object

Resource object representing card