1. Billing
  2. Ramps

Ramps

ramps
copy
Click to Copy
The ramp table, or subscription ramp, represents a planned change to a subscription scheduled to occur at a future date. This table captures such changes, including pricing updates, quantity changes, or plan transitions, without immediately applying them.

Related Tables

Tables referencing ramps.id
ramp_item_tiers ramp_coupons_to_add ramp_items_to_add ramp_discounts_to_add ramp_items_to_update

Columns

No match found
id string, not null
Primary Key
A unique and immutable identifier for the ramp.
subscription_id string, not null
Foreign Key subscriptions.id
The ID of the subscription linked to this ramp.
coupons_to_remove string, not null
List of coupons removed from the subscription, as recorded in the ramp entry.
created_at timestamp, not null
Timestamp indicating when the ramp entry was created in the table.
description string, null
A brief summary of the pricing changes associated with this ramp entry.
discounts_to_remove string, not null
List of discounts removed from the subscription, as recorded in the ramp entry.
effective_from timestamp, not null
The timestamp when the pricing changes recorded in this ramp entry become effective.
items_to_remove string, not null
List of item prices removed from the subscription, as captured in the ramp entry.
resource_version long, null
Version number of this ramp table. The resource_version is updated with a new timestamp in milliseconds for each modification.
status string, not null
The execution status of the ramp. Possible values include:
  • draft: The ramp is in draft state, typically after a subscription update. Details may be provided in status_transition_reason.
    Note: Ramps in draft status are not executed.
  • failed: The ramp failed to execute due to an error.
  • scheduled: The ramp is scheduled for execution.
    Note: A subscription can have up to 12 non-deleted ramps in scheduled status.
  • succeeded: The ramp executed successfully.
status_transition_reason_code string, null
A unique code identifying the status_transition_reason.
status_transition_reason_message string, null
A message that explains the status_transition_reason.
updated_at timestamp, null
Timestamp indicating when this ramp entry was last updated.