Export Subscription Ramps

Idempotency Supported

Starts an export job for subscription ramps data. The exported zip file contains CSV files with ramp-related data.

For a full data export, use filters to export in batches, as suggested in the samples below.

Sample Request

Export all ramps that are in scheduled state.

Exports all ramps that belong to the given subscription.

Exports ramps whose changes take effect between January 1, 2024, and May 31, 2024.

Exports ramps updated from January 1, 2024 onwards.

Exports all ramps updated during the year 2023.

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

export_type

optional, enumerated string, default=data

Determines the format of the data. Returns the export type based on the selected value.

Enum Values

data

Provides the full set of data for the subscription ramps in multiple .csv files.

import_friendly_data

Provides a .csv file whose columns match the ramp schema. This file format can be readily imported through the UI by using Bulk Operations.

ramp

Parameters for ramp

pass parameters as ramp[<param name>]

Export object

Resource object representing export