Recurly: Subscription Overview
Last updated
Was this helpful?
Last updated
Was this helpful?
Each record represents a subscription, enriched with metrics about time, revenue, state, and period.
Recurly
STRING
subscription_id
Unique identifier for the subscription.
DATETIME
updated_at
When the subscription was updated.
STRING
subscription_key
Unique identifier for the subscription daily overview table.
DATETIME
activated_at
When the subscription was activated.
DECIMAL
add_ons_total
Total price of add-ons. Greater or equal to 0.
DATETIME
canceled_at
When the subscription was canceled. Can take future dates.
DATETIME
current_period_ended_at
Current billing period ends at.
DATETIME
current_period_started_at
Current billing period started at.
STRING
expiration_reason
Reason for subscription expiration.
DATETIME
expires_at
When the subscription has expired. Can take future dates.
BOOLEAN
has_auto_renew
Whether the subscription renews at the end of its term. Default: true
INTEGER
subscription_period
The nth subscription defined by the time period set. Subscriptions start with month 0.
STRING
subscription_state
The current state of the subscription. Enum: "active", "canceled", "expired", "failed", "future", "paused"
DATETIME
subscription_end_date
When the subscription actually ends, factors in cancellations earlier than the expected end date.
INTEGER
subscription_interval_days
Subscription interval by number of days, accounting for cancelled/expired periods.
DECIMAL
subtotal
Estimated total, before tax.
DATETIME
trial_ends_at
Trial period ends at.
DATETIME
trial_started_at
Trial period started at.
INTEGER
trial_interval_days
Period of trial, in days.
DECIMAL
unit_amount
Subscription unit price.
STRING
account_id
The account this subscription belongs to.
DATETIME
account_created_at
The date this account was created.
STRING
account_email
Email address associated with the account for this subscription.
STRING
account_first_name
First name associated with the account for this subscription.
STRING
account_last_name
Last name associated with the account for this subscription.
STRING
account_state
Current state of the account.
STRING
plan_code
Unique code to identify the plan. This is used in Hosted Payment Page URLs and in the invoice exports.
DATETIME
plan_created_at
When the plan was created.
DATETIME
plan_deleted_at
When the plan was deleted.
INTEGER
plan_interval_days
The number of days on the expected Recurly plan.
BOOLEAN
plan_is_tax_exempt
true exempts tax on the plan, false applies tax on the plan.
STRING
plan_name
This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
STRING
plan_state
The current state of the plan. Enum: "active", "inactive"
INTEGER
plan_total_billing_cycles
Automatically terminate subscriptions after a defined number of billing cycles. Number of billing cycles before the plan automatically stops renewing, defaults to null for continuous, automatic renewal.