Create A Ramp

The device from which the customer has made the request

The email address of your customer/user. Use this when the email address has only ASCII characters.

The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.

The IP address of the customer where the request originated

skip all actions to be done on the events

One ofall-disabled

skip only emails

One ofall-disabled

skip only webhooks

One ofall-disabled

If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.

<p class="mb-2">The time when this ramp takes effect.</p> <div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Caution</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">Ensure the time is within <strong class="font-semibold">five</strong> years from the current time.</li> <li class="text-base leading-relaxed">Ensure there is a minimum 24-hour interval between <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">effective_from</code> of two consecutive ramps.</li> <li class="text-base leading-relaxed">If the subscription is scheduled to be paused or canceled in the future, ensure the time is not on or after <code><a href="/docs/api/subscriptions/subscription-object#pause_date">pause_date</a></code> or <code><a href="/docs/api/subscriptions/subscription-object#cancelled_at">cancelled_at</a></code>.</li> </ul></div>

A brief summary of the pricing changes applied with this ramp.

List of [coupons](/docs/api/coupons) removed from the subscription through this ramp. **Caution** Ensure this list does **not** include: * Coupons being added through this ramp. * Coupons already removed by a previous ramp.

List of [discounts](/docs/api/discounts) removed from the subscription through this ramp. **Caution** Ensure this list does not include discounts already removed by a previous ramp.

List of [item prices](/docs/api/item_prices) removed from the subscription through this ramp. **Caution** Ensure this list does **not** include: * Item prices being added or updated through this ramp. * Item prices already removed by a previous ramp.

An object that specifies the contract term details.

<p class="mb-2">Action to be taken when the contract term completes.</p> * evergreen - <p class="mb-2">Contract term completes and the subscription renews.</p> * renew - <p class="mb-2">Used when you want to renew the contract term. Does the following:</p> <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">Contract term completes and a new contract term is started for the number of billing cycles specified in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">renewal_billing_cycles</code>.</li> <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">renew</code>.</li> </ul> * renew_once - <p class="mb-2">Used when you want to renew the contract term just once. Does the following:</p> <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">Contract term completes and a new contract term is started for the number of billing cycles specified in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">renewal_billing_cycles</code>.</li> <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel</code>.</li> </ul> * cancel - <p class="mb-2">Contract term completes and subscription is canceled.</p>

One ofrenewevergreencancelrenew_onceDefault "renew"

<p class="mb-2">The number of days before <code><a href="/docs/api/contract_terms/contract_term-object#contract_end">contract_end</a></code> , during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.</p>

<p class="mb-2">Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as <code><a href="/docs/api/contract_terms/contract_term-object#billing_cycle">billing_cycles</a></code> or a custom value depending on the <a href="https://www.chargebee.com/docs/billing/2.0/subscriptions/contract-terms#configuring-contract-terms" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">site configuration</a> .</p>

Details about the \[item prices\](/docs/api/item_prices) added to the subscription through this ramp.

<p class="mb-2">The unique identifier of the item price.</p> <div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Caution</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"> <p class="mb-2">Ensure this list does <strong class="font-semibold">not</strong> include:</p> </li> <li class="text-base leading-relaxed"> <p class="mb-2">Item prices updated or removed through this ramp.</p> </li> <li class="text-base leading-relaxed"> <p class="mb-2">Item prices already in the subscription or added by a previous ramp.</p> </li> <li class="text-base leading-relaxed"> <p class="mb-2">The ramp should not change the <a href="/docs/api/item_prices/item_price-object#period">billing period</a> of the subscription if an upcoming ramp already exists after <code><a href="/docs/api/ramps/create-a-ramp#effective_from">effective_from</a></code> time.</p> </li> </ul></div>

The quantity of the item purchased

The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/currencies) is enabled.

<p class="mb-2">The price/per unit price of the item. When not provided, <a href="/docs/api/item_prices/item-price-object">the value set</a> for the item price is used. This is only applicable when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code> of the item price is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">per_unit</code>. Also, it is only allowed when <a href="https://www.chargebee.com/docs/price-override.html" target="_blank">price overriding</a> is enabled for the site. The value depends on the <a href="/docs/api/currencies">type of currency</a> .</p>

The decimal representation of the price or per-unit price of the plan. The value is in major units of the currency. Always returned when [multi-decimal pricing](/docs/api/currencies) is enabled.

For the plan-item price: the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then [the value set](/docs/api/item_prices/item-price-object) for the plan-item price is used. For addon-item prices: If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html) are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then [the value set under attached addons](/docs/api/attached_items/attached-item-object) is used. Further, if that value is not provided, then [the value set for the addon-item price](/docs/api/item_prices/item-price-object) is used.

The service period of the item in days from the day of charge.

<p class="mb-2">Indicates if the charge-item is to be charged only once or each time the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">charge_on_event</code> occurs. This parameter only applies to charge-items.</p>

Details about the \[item prices\](/docs/api/item_prices) updated in the subscription through this ramp.

The unique identifier of the item price. **Caution** Ensure this list: * Does not include any item price added or removed through this ramp. * Does not include any item price removed by a previous ramp. * Includes only item prices currently in the subscription or added by a previous ramp.

The quantity of the item purchased

The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/currencies) is enabled.

<p class="mb-2">The price/per unit price of the item. When not provided, <a href="/docs/api/item_prices/item-price-object">the value set</a> for the item price is used. This is only applicable when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code> of the item price is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">per_unit</code>. Also, it is only allowed when <a href="https://www.chargebee.com/docs/price-override.html" target="_blank">price overriding</a> is enabled for the site. The value depends on the <a href="/docs/api/currencies">type of currency</a> .</p>

The decimal representation of the price or per-unit price of the plan. The value is in major units of the currency. Always returned when [multi-decimal pricing](/docs/api/currencies) is enabled.

For the plan-item price: the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then [the value set](/docs/api/item_prices/item-price-object) for the plan-item price is used. For addon-item prices: If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html) are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then [the value set under attached addons](/docs/api/attached_items/attached-item-object) is used. Further, if that value is not provided, then [the value set for the addon-item price](/docs/api/item_prices/item-price-object) is used.

The service period of the item in days from the day of charge.

<p class="mb-2">Indicates if the charge-item is to be charged only once or each time the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">charge_on_event</code> occurs. This parameter only applies to charge-items.</p>

<div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Note</strong> Allowed only when both of these conditions are met:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">Price overriding is enabled for the site.</li> <li class="text-base leading-relaxed">pricing_model of the item price is either tiered, volume, or stairstep.</li> </ul></div> <p class="mb-2">Replaces the existing item_tiers for specific <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item_price</code>s within the subscription. You must provide the complete tier set for any <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item_price</code>, even if you&#x27;re changing the price for only one tier.</p>

<p class="mb-2">The identifier of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item_price</code> for which the tier price is being overridden.</p> <div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Caution</strong> The identifier must correspond to an <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item_price</code> listed in either <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">items_to_add</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">items_to_update</code>.</p></div>

The lowest value in the quantity tier.

The highest value in the quantity tier.

The overridden price of the tier. The value depends on the [type of currency](/docs/api/currencies) .

<p class="mb-2">The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ending_unit_in_decimal</code> of the next lower tier. Returned only when the pricing_model is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code> , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code> and <a href="/docs/api/currencies">multi-decimal pricing</a> is enabled.</p>

<p class="mb-2">The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">starting_unit_in_decimal</code> of the next higher tier. Returned only when the pricing_model is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code> , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code> and <a href="/docs/api/currencies">multi-decimal pricing</a> is enabled.</p>

<p class="mb-2">The decimal representation of the per-unit price for the tier when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>. When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code> , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and <a href="/docs/api/currencies">multi-decimal pricing</a> is enabled.</p>

<p class="mb-2">Package size for the tier when pricing type is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">package</code>. Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.</p>

Details about the \[coupons\](/docs/api/coupons) added to the subscription through this ramp.

Unique ID of the coupon to be added. **Caution** * Ensure this list does not include coupons being removed through this ramp. * [Coupon codes](/docs/api/coupon_codes) are not supported.

<p class="mb-2">The date till when the coupon can be applied. Applicable for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">limited_period</code> <a href="/docs/api/coupons">coupons</a> only.</p>

Details about the \[discounts\](/docs/api/discounts) added to the subscription through this ramp.

The percentage of the original amount that should be deducted from it.

The value of the discount. [depends on the kind of currency.](/docs/api/currencies)

<p class="mb-2">The duration of time for which the discount is attached to the subscription, in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period_units</code>. Applicable only when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">duration_type</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">limited_period</code>.</p> <span featureId="cb-discounts" isMicro="true"></span>

<p class="mb-2">The discount is included in MRR calculations for your site. This attribute is only applicable when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">duration_type</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">one_time</code> and when the <a href="https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation" target="_blank">feature is enabled</a> in Chargebee. Also, If the <a href="https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation" target="_blank">site-level setting</a> is to exclude one-time discounts from MRR calculations, this value is always returned <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>.</p> <span featureId="cb-discounts" isMicro="true"></span>

<p class="mb-2">The <a href="/docs/api/subscriptions/subscription-object#subscription_items_item_price_id">id of the item price</a> in the subscription to which the discount is to be applied. Relevant only when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">apply_on</code> = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specific_item_price</code>.</p> <span featureId="cb-discounts" isMicro="true"></span>

<div class="api-description"><span featureId="cb-ramp"></span><p class="mb-2">A <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ramp</code> resource, or subscription ramp, represents a planned change to a <a href="/docs/api/subscriptions" class="text-blue-600 hover:text-blue-800 underline"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription</code></a> 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.</p><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><strong class="font-semibold">Upcoming ramps limit</strong>: A subscription can have a maximum of 12 upcoming ramps at any given time, excluding deleted ramps. Upcoming ramps are ramps with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> as <a href="/docs/api/ramps/ramp-object#status" class="text-blue-600 hover:text-blue-800 underline"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">scheduled</code></a>.</li> <li class="text-base leading-relaxed"><strong class="font-semibold">Total ramps limit</strong>: A subscription can have a maximum of 100 ramps at any given time, excluding deleted ramps.</li> </ul></div><div id="auto-draft" class="cb-accordion"><div class="cb-accordion-title collapsed" data-toggle="collapse" data-target="#auto-draft-content" aria-expanded="false" aria-controls="auto-draft-content"><h4>Auto-draft conditions</h4><i class="fa fa-chevron-circle-down fa-lg" aria-hidden="true"></i></div><div class="collapse" id="auto-draft-content"><p class="mb-2">When you create or update a ramp, Chargebee automatically moves any existing ramps scheduled after that ramp to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">draft</code> status if either of the following conditions is met:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">The new or updated ramp changes the subscription <a href="subscriptions#subscription_current_term_end" class="text-blue-600 hover:text-blue-800 underline">term end date</a>.</li> <li class="text-base leading-relaxed">The new or updated ramp changes the subscription billing frequency. That is, either of the following <a href="subscriptions#subscription_items" class="text-blue-600 hover:text-blue-800 underline">attributes</a> is changed: <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription_items[i].billing_period</code></li> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription_items[i].billing_period_unit</code></li> <li class="text-base leading-relaxed">where <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">i</code> is the index where <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription_items[i].item_type</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">plan</code>.</li> </ul> </li> <li class="text-base leading-relaxed">The new or updated ramp introduces an <a href="item_prices#item_price_item_type" class="text-blue-600 hover:text-blue-800 underline">addon</a> that is not <a href="attached_items" class="text-blue-600 hover:text-blue-800 underline">applicable</a> to the plan in one or more of the subsequent ramps.</li> </ul></div></div></div>

A unique and immutable identifier for the ramp.

A brief summary of the pricing changes applied with this ramp.

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

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

<p class="mb-2">The execution status of the ramp</p> * succeeded - <p class="mb-2">The ramp completed successfully.</p> * scheduled - <p class="mb-2">The ramp has been created and scheduled for execution.</p> <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong> Excluding deleted ramps, a subscription can have a maximum of 12 ramps in the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">scheduled</code> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>.</p></div> * draft - <p class="mb-2">The ramp is moved to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">draft</code> status when the associated subscription is updated. The reason for the draft status can be explained in the <a href="/docs/api/ramps/ramp-object#status_transition_reason" target="_blank">status_transition_reason</a></p> <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong> Ramps in draft state will not be executed.</p></div> * failed - <p class="mb-2">The ramp did not complete because of an error.</p>

One ofscheduledsucceededfaileddraft

Timestamp indicating when this resource was created.

<p class="mb-2">Version number of this resource. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code> is updated with a new timestamp in milliseconds for every change made to the resource.</p>

Timestamp indicating when this resource was last updated.

List of [item prices](/docs/api/item_prices) removed from the subscription through this ramp.

List of [coupons](/docs/api/coupons) removed from the subscription through this ramp.

List of [discounts](/docs/api/discounts) removed from the subscription through this ramp.

<p class="mb-2">Indicates if the ramp is marked as deleted. To retrieve deleted ramps, use the <a href="/docs/api/ramps/list-ramps">List subscription ramps</a> endpoint with <code><a href="/docs/api/ramps/list-ramps">include_deleted</a></code> set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code> .</p>

Details about the [item prices](/docs/api/item_prices) added to the subscription through this ramp.

Details about the [item prices](/docs/api/item_prices) updated in the subscription through this ramp.

Details about the [coupons](/docs/api/coupons) added to the subscription through this ramp.

Details about the [discounts](/docs/api/discounts) added to the subscription through this ramp.

<div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong> Allowed only when both of these conditions are met:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/2.0/price-override.html" target="_blank">Price overriding</a> is enabled for the site.</li> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code> of the item price is either <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>, or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>.</li> </ul></div> <p class="mb-2">Overrides the <code><a href="/docs/api/subscriptions/subscription-object#item_tiers">item_tiers</a></code> for specific <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item_prices</code> of the subscription.</p>

An object that specifies the contract term details.

<p class="mb-2">Detailed reason for the status transition of a ramp to <code><a href="/docs/api/ramps/ramp-object#status" target="_blank">draft</a></code> and <code><a href="/docs/api/ramps/ramp-object#status" target="_blank">failed</a></code> status.</p>