ChargebeeAPI

Ramps

A ramp resource, or subscription ramp, represents a planned change to a subscription that occurs at a future date. Use this resource to define and schedule subscription modifications, such as updating pricing, altering quantity, or transitioning to a different plan, without immediately applying them.

Note

  • Upcoming ramps limit: A subscription can have a maximum of 12 upcoming ramps at any given time, excluding deleted ramps. Upcoming ramps are ramps with status as scheduled.
  • Total ramps limit: A subscription can have a maximum of 100 ramps at any given time, excluding deleted ramps.

Sample RampJSON

API Index URL

https://[site].chargebee.com/api/v2/ramps

Ramps attributes

id
required, string, max chars=50

A unique and immutable identifier for the ramp.

subscription_id
required, string, max chars=50

The ID of the subscription for which this ramp was created.

effective_from
required, timestamp(UTC) in seconds

Specifies the time when the changes to the subscription will be applied by executing the ramp.

status
required, enumerated string

The execution status of the ramp

Possible Enum Values
scheduled

The ramp has been created and scheduled for execution.

Note Excluding deleted ramps, a subscription can have a maximum of 12 ramps in the scheduled status.

succeeded

The ramp completed successfully.

failed

The ramp did not complete because of an error.

draft

The ramp is moved to draft status when the associated subscription is updated. The reason for the draft status can be explained in the status_transition_reason

Note Ramps in draft state will not be executed.

created_at
required, timestamp(UTC) in seconds

Timestamp indicating when this resource was created.

resource_version
optional, long

Version number of this resource. The resource_version is updated with a new timestamp in milliseconds for every change made to the resource.

updated_at
optional, timestamp(UTC) in seconds

Timestamp indicating when this resource was last updated.

items_to_remove
optional, string, max chars=100

List of item prices removed from the subscription through this ramp.

coupons_to_remove
optional, string, max chars=100

List of coupons removed from the subscription through this ramp.

discounts_to_remove
optional, string, max chars=100

List of discounts removed from the subscription through this ramp.

deleted
required, boolean

Indicates if the ramp is marked as deleted. To retrieve deleted ramps, use the List subscription ramps endpoint with include_deleted set to true .

items_to_add

Details about the item prices added to the subscription through this ramp.

items_to_update

Details about the item prices updated in the subscription through this ramp.

coupons_to_add

Details about the coupons added to the subscription through this ramp.

discounts_to_add

Details about the discounts added to the subscription through this ramp.

item_tiers

Note Allowed only when both of these conditions are met:

  • Price overriding is enabled for the site.
  • pricing_model of the item price is either tiered, volume, or stairstep.

Overrides the item_tiers for specific item_prices of the subscription.

contract_term

An object that specifies the contract term details.

status_transition_reason

Detailed reason for the status transition of a ramp to draft and failed status.