GET /ramps

Lists the subscription ramps that match the criteria provided in the filter parameters.

Note

By default, the ramps are returned sorted in descending order (latest first) by updated_at.

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

Request headers

Name	Type	Required	Description
`chargebee-request-origin-device`	String	No	The device from which the customer has made the request
`chargebee-business-entity-id`	String	No	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.
`chargebee-request-origin-user`	String	No	The email address of your customer/user. Use this when the email address has only ASCII characters.
`chargebee-request-origin-ip`	String	No	The IP address of the customer where the request originated
`chargebee-request-origin-user-encoded`	String	No	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.

Query parameters

Name	Type	Required	Description
`limit`	Integer	No	The number of resources to be returned. Default value: 10
`effective_from`	Object	No	optional, timestamp(UTC) in seconds filterFilter subscription ramps based on `effective_from`. Caution The `subscription_id` filter must be passed when filtering by `effective_from`. `effective_from` filter should not be passed when `include_deleted` is set to `true`. Supported operators : after, before, on, betweenExample → effective_from[after] = "1435054328"
`status`	Object	No	optional, enumerated string filterFilter subscription ramps based on `status`. Caution The `subscription_id` filter must be passed when filtering by `status`. `status` filter should not be passed when `include_deleted` is set to `true`. Possible values are : scheduled, succeeded, failed.Supported operators : is, inExample → status[is] = "SCHEDULED"
`sort_by`	Object	No	optional, string filterSorts based on the specified attribute. Supported attributes : effective_from, created_at, updated_atSupported sort-orders : asc, descExample → sort_by[asc] = "effective_from"This will sort the result based on the 'effective_from' attribute in ascending(earliest first) order.
`offset`	String	No	Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set `offset` to the value of `next_offset` obtained in the previous iteration of the API call.
`include_deleted`	Boolean	No	If set to true, includes the deleted resources in the response. For the deleted resources in the response, the '\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\deleted\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\ ' attribute will be '\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\true\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\'. Default value: false
`subscription_id`	Object	Yes	optional, string filterFilter subscription ramps based on `subscription_id`. Caution This filter is mandatory when filtering by `status` or `effective_from`. Supported operators : is, inExample → subscription_id[is] = "8gsnbYfsMLds"
`updated_at`	Object	No	optional, timestamp(UTC) in seconds filterFilter subscription ramps based on `updated_at`. Tip Specify `sort_by` = `updated_at` (whether `asc` oor `desc`) for a faster response when using this filter. Supported operators : after, before, on, betweenExample → updated_at[after] = "1435052328"

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.