Recurly activities and attributes
Overview
When you connect Recurly, activities are automatically added to your Ortto account. This article provides a list of those activities and their attributes.
Accessing Recurly activities
To access Recurly activities, go to CDP > Activities.
Recurly activities
NOTE: Recurly activities cannot be modified in Ortto.
Invoice
The Invoice activity is created to record billing transactions when a subscription starts, renews, or when one-time charges are applied to an account.
Attribute | Field Type | Description |
---|---|---|
Account code | Text | The identifier for the account related to the invoice. |
Invoice number | Text | The identifying number assigned to the invoice. |
Type | Text | Specifies the type of invoice (e.g., one-time or recurring). |
Origin | Text | Identifies the source of the invoice generation. |
State | Text | The current status of the invoice (e.g., open, paid). |
PO number | Text | The purchase order number associated with the invoice. |
Vat number | Text | The VAT identification number for tax purposes. |
Total | Currency | The total amount due for the invoice. |
Paid | Currency | The amount that has been paid toward the invoice. |
Net terms | Number | The payment terms for the invoice, defining when it is due. |
Collection method | Text | Indicates how payment will be collected (e.g., automatic or manual). |
Closed at | Time and date | The date and time when the invoice was closed. |
Discounts applied | Currency | The total amount of discounts applied to the invoice. |
Country | Geo | The country where the invoice was generated. |
Region | Geo | The region (e.g., state or province) where the invoice was generated. |
City | Geo | The city where the invoice was generated. |
New trial
The New trial activity is created when an account is enrolled in a trial period for a subscription.
Attribute | Field Type | Description |
---|---|---|
Account code | Text | A unique identifier for the account associated with the trial. |
Value | Currency | The monetary value of the trial. |
MRR | Currency | Monthly Recurring Revenue generated from the trial. |
ARR | Currency | Annual Recurring Revenue generated from the trial. |
Change type | Text | Describes the type of change in the trial (e.g., upgrade, downgrade). |
Old Change type | Text | The type of change before the current one. |
Plan | Text | The name of the subscription plan linked to the trial. |
Old Plan | Text | The previous plan before the change, if applicable. |
Plan code | Text | A unique identifier for the plan associated with the trial. |
Addons codes | Text list | A list of codes for addons associated with the trial. |
Addons total MRR | Currency | Total Monthly Recurring Revenue from addons included in the trial. |
State | Text | The current state of the trial (e.g., active, canceled). |
Discounts applied | Currency | The total discounts applied during the trial. |
Activated at | Time and date | The date and time when the trial was activated. |
Canceled at | Time and date | The date and time when the trial was canceled, if applicable. |
Expires at | Time and date | The date and time when the trial is set to expire. |
Current period started at | Time and date | The date and time when the current billing period began. |
Current period ends at | Time and date | The date and time when the current billing period will end. |
Current term started at | Time and date | The date and time when the current subscription term began. |
Current term ends at | Time and date | The date and time when the current subscription term will end. |
Trial started at | Time and date | The date and time when the trial started. |
Trial ends at | Time and date | The date and time when the trial will end. |
Collection method | Text | How payments will be collected during the trial (e.g., automatic, manual). |
Collection interval | Text | The frequency of payment collection (e.g., monthly, annually). |
Country | Geo | The country associated with the account during the trial. |
Region | Geo | The region (e.g., state or province) associated with the trial. |
City | Geo | The city associated with the trial. |
Payment
The Payment activity is created when a payment transaction is successfully processed for an account.
Attribute | Field Type | Description |
---|---|---|
Account code | Text | An identifying code for the account related to the payment. |
Invoice number | Text | The invoice number associated with the payment. |
Status | Text | The current status of the payment (e.g., success, declined). |
Amount | Currency | The total amount of the payment. |
Currency | Text | The currency used for the payment. |
Success | Boolean | Indicates whether the payment was successful (true/false). |
Status message | Text | A message describing the payment status (e.g., The card has insufficient funds to cover the cost of the transaction). |
Customer message | Text | A message sent to the customer regarding the payment. |
Country | Geo | The country associated with the payment. |
Region | Geo | The region (e.g., state or province) where the payment originated. |
City | Geo | The city where the payment was made. |
Total paid | Currency | The total amount that has been paid for the invoice. |
Subscription cancelled
The Subscription cancelled activity is created when a subscription is canceled, either by the account holder or automatically due to a failed payment.
Attribute | Field Type | Description |
---|---|---|
Account code | Text | An identifying code for the account associated with the canceled subscription. |
Value | Currency | The monetary value of the canceled subscription. |
MRR | Currency | Monthly Recurring Revenue affected by the cancellation. |
ARR | Currency | Annual Recurring Revenue affected by the cancellation. |
Change type | Text | Describes the type of change leading to the cancellation (e.g. Churn, Contraction) |
Old Change type | Text | The previous change type before the cancellation. |
Plan | Text | The name of the subscription plan being canceled. |
Old Plan | Text | The previous plan before the change, if applicable. |
Plan code | Text | A identifying code for the canceled subscription plan. |
Addons codes | Text list | A list of codes for any addons included in the subscription. |
Addons total MRR | Currency | Total Monthly Recurring Revenue from addons included in the canceled subscription. |
State | Text | The current state of the subscription (e.g., canceled, expired). |
Discounts applied | Currency | The total amount of discounts applied before the cancellation. |
Activated at | Time and date | The date and time when the subscription was activated. |
Canceled at | Time and date | The date and time when the subscription was canceled. |
Expires at | Time and date | The date and time when the subscription will fully expire. |
Current period started at | Time and date | The date and time when the current billing period started. |
Current period ends at | Time and date | The date and time when the current billing period will end. |
Current term started at | Time and date | The date and time when the current subscription term started. |
Current term ends at | Time and date | The date and time when the current subscription term will end. |
Trial started at | Time and date | The date and time when the subscription trial began, if applicable. |
Trial ends at | Time and date | The date and time when the subscription trial will end. |
Collection method | Text | Indicates how payments were collected during the subscription (e.g., automatic, manual). |
Collection interval | Text | The frequency of payment collection during the subscription. |
Country | Geo | The country associated with the canceled subscription. |
Region | Geo | The region (e.g., state or province) associated with the cancellation. |
City | Geo | The city associated with the canceled subscription. |
Subscription change
The Subscription change activity is created when modifications are made to an existing subscription, such as upgrading or downgrading the plan, changing the billing cycle, or adjusting add-ons.
Attribute | Field Type | Description |
---|---|---|
Account code | Text | The account reference associated with the subscription change. |
Value | Currency | The monetary value of the subscription after the change. |
MRR | Currency | Monthly Recurring Revenue impacted by the subscription change. |
ARR | Currency | Annual Recurring Revenue impacted by the subscription change. |
Change type | Text | Describes the type of modification made (e.g. Expansion, Reactivation). |
Old Change type | Text | The previous type of change before the current modification. |
Plan | Text | The name of the updated subscription plan. |
Old Plan | Text | The previous subscription plan before the change. |
Plan code | Text | The reference code for the new subscription plan. |
Addons codes | Text list | A list of codes for any addons included in the updated subscription. |
Addons total MRR | Currency | Total Monthly Recurring Revenue from addons in the subscription. |
State | Text | The current status of the subscription (e.g., active, expired). |
Discounts applied | Currency | The total amount of discounts applied to the subscription. |
Activated at | Time and date | The date and time when the subscription became active. |
Canceled at | Time and date | The date and time when the subscription was canceled, if applicable. |
Expires at | Time and date | The date and time when the subscription is set to expire. |
Current period started at | Time and date | The date and time when the current billing period began. |
Current period ends at | Time and date | The date and time when the current billing period will end. |
Current term started at | Time and date | The start date and time of the current subscription term. |
Current term ends at | Time and date | The end date and time of the current subscription term. |
Trial started at | Time and date | The start date and time of the trial, if applicable. |
Trial ends at | Time and date | The end date and time of the trial, if applicable. |
Collection method | Text | Specifies how payments will be collected (e.g., automatic, manual). |
Collection interval | Text | The frequency of payment collection (e.g., monthly, yearly). |
Country | Geo | The country where the subscription change occurred. |
Region | Geo | The region (e.g., state or province) where the subscription was changed. |
City | Geo | The city where the subscription change occurred. |
Trial Cancelled
The Trial cancelled activity is created when a trial period for a subscription is ended prematurely.
Attribute | Field Type | Description |
---|---|---|
Account code | Text | The account reference tied to the canceled trial. |
Value | Currency | The monetary value of the trial subscription. |
MRR | Currency | Monthly Recurring Revenue affected by the cancellation. |
ARR | Currency | Annual Recurring Revenue impacted by the trial cancellation. |
Change type | Text | Describes the type of change leading to the cancellation (e.g. New, Free) |
Old Change type | Text | The previous type of change before the trial cancellation. |
Plan | Text | The name of the subscription plan associated with the canceled trial. |
Old Plan | Text | The previous plan before any changes, if applicable. |
Plan code | Text | The code for the subscription plan linked to the canceled trial. |
Addons codes | Text list | A list of addon codes tied to the canceled trial. |
Addons total MRR | Currency | Total Monthly Recurring Revenue from addons associated with the canceled trial. |
State | Text | The current status of the trial (e.g., canceled, expired). |
Discounts applied | Currency | The total amount of discounts applied during the trial. |
Activated at | Time and date | The date and time when the trial became active. |
Canceled at | Time and date | The date and time when the trial was canceled. |
Expires at | Time and date | The date and time when the trial subscription will expire. |
Current period started at | Time and date | The start date and time of the current billing period, if applicable. |
Current period ends at | Time and date | The end date and time of the current billing period. |
Current term started at | Time and date | The date and time when the current subscription term started. |
Current term ends at | Time and date | The date and time when the current subscription term will end. |
Trial started at | Time and date | The date and time when the trial began. |
Trial ends at | Time and date | The date and time when the trial will end or expire. |
Collection method | Text | Describes how payments would have been collected during the trial (e.g., automatic, manual). |
Collection interval | Text | The frequency of payment collection, if applicable. |
Country | Geo | The country linked to the canceled trial. |
Region | Geo | The region (e.g., state or province) linked to the trial cancellation. |
City | Geo | The city where the trial was active or canceled. |
Trial Expired
The Trial expired activity is created when a trial period for a subscription reaches its end without a successful conversion to a paid subscription.
Attribute | Field Type | Description |
---|---|---|
Account code | Text | The account reference linked to the expired trial. |
Value | Currency | The monetary value associated with the trial before expiration. |
MRR | Currency | Monthly Recurring Revenue impacted by the trial expiration. |
ARR | Currency | Annual Recurring Revenue affected by the trial expiration. |
Change type | Text | Describes the nature of the change that occurred during the trial (e.g. New, Free). |
Old Change type | Text | The type of change before the current status of the trial. |
Plan | Text | The name of the subscription plan associated with the trial. |
Old Plan | Text | The subscription plan prior to the most recent change, if applicable. |
Plan code | Text | The code representing the subscription plan tied to the expired trial. |
Addons codes | Text list | A list of addon codes tied to the trial subscription. |
Addons total MRR | Currency | Total Monthly Recurring Revenue from addons included in the trial. |
State | Text | The current state of the trial (e.g., expired). |
Discounts applied | Currency | The total discounts that were applied during the trial. |
Activated at | Time and date | The date and time when the trial was activated. |
Canceled at | Time and date | The date and time when the trial was canceled, if applicable. |
Expires at | Time and date | The date and time when the trial expired. |
Current period started at | Time and date | The start date and time of the current billing period, if applicable. |
Current period ends at | Time and date | The end date and time of the current billing period. |
Current term started at | Time and date | The date and time when the current subscription term started. |
Current term ends at | Time and date | The date and time when the current subscription term will end. |
Trial started at | Time and date | The date and time when the trial began. |
Trial ends at | Time and date | The date and time when the trial reached its expiration. |
Collection method | Text | Specifies how payments were collected during the trial (e.g., automatic, manual). |
Collection interval | Text | The frequency of payment collection during the trial, if applicable. |
Country | Geo | The country associated with the trial account. |
Region | Geo | The region (e.g., state or province) tied to the trial. |
City | Geo | The city linked to the trial account. |