Subscriptions - Ramp Pricing Export

This export returns the ramp interval data for each subscription with ramp priced billing model.

Version Change Log

Version 11/23/21

Subscription Status Filter

Live

All active subscriptions.

Renewing

Live subscriptions that will renew after the current term.

Trial

Live subscriptions that are in a trial period.

Paused

Live subscriptions that are currently paused.

Canceled

Live subscriptions that will not renew after the current term.

Past Due

Live subscriptions with a past-due invoice.

Future

Subscriptions that will become active when the start date arrives.

Expired

Inactive subscriptions.

Failed

This status refers to subscriptions that were never created due to a failed credit card validation. This status can also refer to a future subscription that is terminated prior to its start_date.

Date Range Filters

Modified

Subscriptions that were modified during the selected time range. Uses in the "modified_at" column of the export. You will only see the subscription modified- original subscription will not show when using export on modified parameter.

Created

Subscriptions that were created during the selected time range. Uses the "created_at" column of the export. This option will include subscriptions that have been created but have a future activation date.

Export Contents

Column Name

Example

Description

uuid

b964b5439c2548a489

Unique internal identifier for the subscription. Even if a subscription is modified, this identifier is maintained. This identifier matches other exports such as the Subscriptions export.

ramp_id

101112

A unique internal identifier for ramp pricing, which can be matched up with the current_ramp_id value from the subscriptions export.

unit_amount

14.99

The unit amount for each ramp interval.

starting_billing_cycle

2

The starting billing cycle of the ramp interval.

elapsed_billing_cycles

2

The number of billing cycles that have elapsed in a ramp interval. When elapsed matches total_billing_cycles, the ramp interval has completed.

total_billing_cycles

3

The total number of billing cycles in a ramp interval.

started_at

2021-05-08 12:53:10 MDT

The date that the ramp interval started.

ended_at

2021-05-09 12:53:10 MDT

The date that the ramp interval ended.

estimated_start_date

2021-05-11 12:53:10 MDT

The estimated start date of a future ramp interval.