Skip to content
Book a demoStart free
Connectors

Recurly connector

Set up the Recurly connector in Kaivo: authentication, configuration, the 18 BigQuery tables it syncs, and answers to common questions.

Recurly connector pricing, tier and credits on kaivo.io

Kaivo is a fully managed data platform that syncs your Recurly data into a Google BigQuery warehouse and keeps it up to date automatically. There is no pipeline to build and no infrastructure to run, so you can spend your time analysing your payment and finance data instead of moving it.

Sync your Recurly subscription data into BigQuery with Kaivo to analyse recurring revenue, churn, and billing alongside the rest of your finance data.

CategoryFinance & Payments
AuthenticationAPI key
SetupSelf-service

Getting started with the Recurly connector

Section titled “Getting started with the Recurly connector”
  1. Sign up for Kaivo and create a workspace.
  2. Connect your Recurly account.
  3. Choose which tables to sync.
  4. Wait for the initial sync to finish.
  5. Query your data in BigQuery or your favourite AI or BI tool.

Authenticate with your API Key.

Field Description
API Key
Your Recurly API key. You can find it in your Recurly account under Admin → API Credentials.

|

When you set up the connector, you provide:

Field Description
Start Date
Any data before this date will not be fetched.

| | Use Sandbox Environment |

Enable for sandbox accounts (400 requests/min). Disable for production accounts (1,000 GET requests/min).

|

Kaivo syncs 18 tables from Recurly into a dedicated dataset in your BigQuery warehouse. Click any table to see its columns and types.

account_coupon_redemptions (60 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
account__bill_to STRING
account__code STRING
account__company STRING
account__dunning_campaign_id STRING
account__email STRING
account__first_name STRING
account__id STRING
account__last_name STRING
account__object STRING
account__parent_account_id STRING
coupon__applies_to_all_items BOOL
coupon__applies_to_all_plans BOOL
coupon__applies_to_non_plan_charges BOOL
coupon__code STRING
coupon__coupon_type STRING
coupon__created_at TIMESTAMP
coupon__discount__type STRING
coupon__discount__percent INT64 This is only present when `type=percent`.
coupon__discount__trial__length INT64 Trial length measured in the units specified by the sibling `unit` property
coupon__discount__trial__unit STRING Temporal unit of the free trial
coupon__duration STRING
coupon__expired_at TIMESTAMP
coupon__free_trial_amount FLOAT64
coupon__free_trial_unit STRING
coupon__hosted_page_description STRING
coupon__id STRING
coupon__invoice_description STRING
coupon__max_redemptions FLOAT64
coupon__max_redemptions_per_account FLOAT64
coupon__name STRING
coupon__object STRING
coupon__redeem_by STRING
coupon__redemption_resource STRING
coupon__state STRING
coupon__temporal_amount FLOAT64
coupon__temporal_unit STRING
coupon__unique_code_template STRING
coupon__unique_coupon_code__bulk_coupon_code STRING The Coupon code of the parent Bulk Coupon
coupon__unique_coupon_code__bulk_coupon_id STRING The Coupon ID of the parent Bulk Coupon
coupon__unique_coupon_code__code STRING The code the customer enters to redeem the coupon.
coupon__unique_coupon_code__created_at TIMESTAMP
coupon__unique_coupon_code__expired_at TIMESTAMP The date and time the coupon was expired early or reached its `max_redemptions`.
coupon__unique_coupon_code__id STRING
coupon__unique_coupon_code__object STRING
coupon__unique_coupon_code__redeemed_at TIMESTAMP The date and time the unique coupon code was redeemed.
coupon__unique_coupon_code__state STRING Indicates if the unique coupon code is redeemable or why not.
coupon__unique_coupon_code__updated_at TIMESTAMP
coupon__unique_coupon_codes_count FLOAT64
coupon__updated_at TIMESTAMP
created_at TIMESTAMP The date and time when the redemption was created
currency STRING The currency in which the redemption was made
discounted FLOAT64 The amount discounted by the coupon
id STRING The unique identifier for the redemption
object STRING The type of object this represents
removed_at TIMESTAMP The date and time when the redemption was removed (if applicable)
state STRING The current state of the redemption
subscription_id STRING The subscription associated with the redemption
updated_at TIMESTAMP The date and time when the redemption was last updated
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.

Repeating fields are split into their own tables, listed here with their column counts.

  • account_coupon_redemptions__coupon__discount__currencies (5 columns)
  • account_coupon_redemptions__coupon__items (4 columns)
  • account_coupon_redemptions__coupon__plans (5 columns)
account_notes (15 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
account_id STRING The unique identifier of the account associated with this note.
created_at TIMESTAMP The date and time when the note was created.
id STRING The unique identifier for this note.
message STRING The content or message of the note.
object STRING Represents the object type, in this case, ‘note’.
user__created_at TIMESTAMP
user__deleted_at TIMESTAMP
user__email STRING
user__first_name STRING
user__id STRING
user__last_name STRING
user__object STRING
user__time_zone STRING
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.
accounts (87 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
address__city STRING City of the address
address__country STRING Country, 2-letter ISO 3166-1 alpha-2 code.
address__geo_code STRING Geographical coordinates of the address
address__phone STRING Phone number associated with the address
address__postal_code STRING Zip or postal code.
address__region STRING State or province.
address__street1 STRING First line of the street address
address__street2 STRING Second line of the street address
acquisition__acquired_at TIMESTAMP The date and time when the account was acquired
acquisition__campaign STRING The campaign associated with the acquisition
acquisition__channel STRING The channel through which the account was acquired
acquisition__cost__amount FLOAT64 The amount of the cost
acquisition__cost__currency STRING The currency of the cost amount
acquisition__subchannel STRING The subchannel associated with the acquisition
bill_to STRING The billing details
billing_info__account_id STRING
billing_info__address__city STRING
billing_info__address__country STRING Country, 2-letter ISO 3166-1 alpha-2 code.
billing_info__address__phone STRING
billing_info__address__postal_code STRING Zip or postal code.
billing_info__address__region STRING State or province.
billing_info__address__street1 STRING
billing_info__address__street2 STRING
billing_info__backup_payment_method BOOL The `backup_payment_method` field is used to indicate a billing info as a backup on the account that will be tried if the initial billing info used for an invoice is declined.
billing_info__company STRING
billing_info__created_at TIMESTAMP When the billing information was created.
billing_info__first_name STRING
billing_info__fraud__decision STRING
billing_info__fraud__score INT64
billing_info__id STRING
billing_info__last_name STRING
billing_info__object STRING
billing_info__payment_method__account_type STRING The bank account type. Only present for ACH payment methods.
billing_info__payment_method__billing_agreement_id STRING Billing Agreement identifier. Only present for Amazon or Paypal payment methods.
billing_info__payment_method__card_type STRING Visa, MasterCard, American Express, Discover, JCB, etc.
billing_info__payment_method__cc_bin_country STRING The 2-letter ISO 3166-1 alpha-2 country code associated with the credit card BIN, if known by Recurly. Available on the BillingInfo object only. Available when the BIN country lookup feature is enabled.
billing_info__payment_method__exp_month INT64 Expiration month.
billing_info__payment_method__exp_year INT64 Expiration year.
billing_info__payment_method__first_six STRING Credit card number’s first six digits.
billing_info__payment_method__gateway_code STRING An identifier for a specific payment gateway.
billing_info__payment_method__gateway_token STRING A token used in place of a credit card in order to perform transactions.
billing_info__payment_method__last_four STRING Credit card number’s last four digits. Will refer to bank account if payment method is ACH.
billing_info__payment_method__last_two STRING The IBAN bank account’s last two digits.
billing_info__payment_method__name_on_account STRING The name associated with the bank account.
billing_info__payment_method__object STRING
billing_info__payment_method__routing_number STRING The bank account’s routing number. Only present for ACH payment methods.
billing_info__payment_method__routing_number_bank STRING The bank name of this routing number.
billing_info__primary_payment_method BOOL The `primary_payment_method` field is used to indicate the primary billing info on the account. The first billing info created on an account will always become primary. This payment method will be used
billing_info__updated_at TIMESTAMP When the billing information was last changed.
billing_info__updated_by__country STRING
billing_info__updated_by__ip STRING
billing_info__valid BOOL
billing_info__vat_number STRING Customer’s VAT number (to avoid having the VAT applied). This is only used for automatically collected invoices.
cc_emails STRING Email addresses for carbon copy (CC)
code STRING Unique code assigned to the account
company STRING Company associated with the account
created_at TIMESTAMP Date and time when the account was created
deleted_at TIMESTAMP Date and time when the account was deleted
dunning_campaign_id STRING Campaign ID for dunning management
email STRING Email address of the account holder
entity_use_code STRING Entity use code for tax exemption
exemption_certificate STRING Exemption certificate details
first_name STRING First name of the account holder
has_active_subscription BOOL Flag indicating if the account has an active subscription
has_canceled_subscription BOOL Flag indicating if the account has a canceled subscription
has_future_subscription BOOL Flag indicating if the account has a future subscription
has_live_subscription BOOL Flag indicating if the account has a live subscription
has_past_due_invoice BOOL Flag indicating if the account has a past due invoice
has_paused_subscription BOOL Flag indicating if the account has a paused subscription
hosted_login_token STRING Token for hosted login functionality
id STRING Unique identifier of the account
invoice_template_id STRING ID of the invoice template used
last_name STRING Last name of the account holder
object STRING Type of object
override_business_entity_id STRING ID for overriding business entity
parent_account_id STRING ID of the parent account
parent_account_code STRING Code of the parent account
preferred_locale STRING Preferred language/locale of the account holder
preferred_time_zone STRING Preferred time zone of the account holder
state STRING State/province of the account address
tax_exempt BOOL Flag indicating if the account is tax exempt
transaction_type STRING Type of transaction associated with the account
updated_at TIMESTAMP Date and time when the account was last updated
username STRING Username of the account holder
vat_number STRING VAT (Value Added Tax) number of the account
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.

Repeating fields are split into their own tables, listed here with their column counts.

  • accounts__custom_fields (3 columns)
  • accounts__external_accounts (9 columns)
  • accounts__shipping_addresses (22 columns)
add_ons (23 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
accounting_code STRING Accounting code for invoice line items for this add-on. If no value is provided, it defaults to add-on’s code.
add_on_type STRING Whether the add-on type is fixed, or usage-based.
avalara_service_type STRING Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the add-on is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
avalara_transaction_type STRING Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the add-on is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
code STRING The unique identifier for the add-on within its plan.
created_at TIMESTAMP The date and time when the add-on was created.
default_quantity INT64 Default quantity for the hosted pages.
deleted_at TIMESTAMP The date and time when the add-on was deleted, if applicable.
display_quantity BOOL Determines if the quantity field is displayed on the hosted pages for the add-on.
id STRING The unique identifier for the add-on.
measured_unit_id STRING System-generated unique identifier for an measured unit associated with the add-on.
name STRING Describes your add-on and will appear in subscribers’ invoices.
optional BOOL Whether the add-on is optional for the customer to include in their purchase on the hosted payment page. If false, the add-on will be included when a subscription is created through the Recurly UI. However, the add-on will not be included when a subscription is created through the API.
plan_id STRING The ID of the plan to which the add-on is associated.
revenue_schedule_type STRING When this add-on is invoiced, the line item will use this revenue schedule. If `item_code`/`item_id` is part of the request then `revenue_schedule_type` must be absent in the request as the value will be set from the item.
state STRING Add-ons can be either active or inactive.
tax_code STRING Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
tier_type STRING The pricing model for the add-on. For more information,[click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our[Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of howto configure quantity-based pricing models.
updated_at TIMESTAMP The date and time when the add-on was last updated.
usage_percentage FLOAT64 The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0.
usage_type STRING Type of usage, returns usage type if `add_on_type` is `usage`.
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.

Repeating fields are split into their own tables, listed here with their column counts.

  • add_ons__currencies (5 columns)
billing_infos (40 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
account_id STRING
address__city STRING
address__country STRING Country, 2-letter ISO 3166-1 alpha-2 code.
address__phone STRING
address__postal_code STRING Zip or postal code.
address__region STRING State or province.
address__street1 STRING
address__street2 STRING
backup_payment_method BOOL The `backup_payment_method` field is used to indicate a billing info as a backup on the account that will be tried if the initial billing info used for an invoice is declined.
company STRING
created_at TIMESTAMP When the billing information was created.
first_name STRING
fraud__decision STRING
fraud__score INT64
id STRING
last_name STRING
object STRING
payment_method__account_type STRING The bank account type. Only present for ACH payment methods.
payment_method__billing_agreement_id STRING Billing Agreement identifier. Only present for Amazon or Paypal payment methods.
payment_method__card_type STRING Visa, MasterCard, American Express, Discover, JCB, etc.
payment_method__cc_bin_country STRING The 2-letter ISO 3166-1 alpha-2 country code associated with the credit card BIN, if known by Recurly. Available on the BillingInfo object only. Available when the BIN country lookup feature is enabled.
payment_method__exp_month INT64 Expiration month.
payment_method__exp_year INT64 Expiration year.
payment_method__first_six STRING Credit card number’s first six digits.
payment_method__gateway_code STRING An identifier for a specific payment gateway.
payment_method__gateway_token STRING A token used in place of a credit card in order to perform transactions.
payment_method__last_four STRING Credit card number’s last four digits. Will refer to bank account if payment method is ACH.
payment_method__last_two STRING The IBAN bank account’s last two digits.
payment_method__name_on_account STRING The name associated with the bank account.
payment_method__object STRING
payment_method__routing_number STRING The bank account’s routing number. Only present for ACH payment methods.
payment_method__routing_number_bank STRING The bank name of this routing number.
primary_payment_method BOOL The `primary_payment_method` field is used to indicate the primary billing info on the account. The first billing info created on an account will always become primary. This payment method will be used
updated_at TIMESTAMP When the billing information was last changed.
updated_by__country STRING
updated_by__ip STRING
valid BOOL
vat_number STRING Customer’s VAT number (to avoid having the VAT applied). This is only used for automatically collected invoices.
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.
coupons (41 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
applies_to_all_items BOOL
applies_to_all_plans BOOL
applies_to_non_plan_charges BOOL
code STRING
coupon_type STRING
created_at TIMESTAMP
discount__type STRING
discount__percent INT64 This is only present when `type=percent`.
discount__trial__length INT64 Trial length measured in the units specified by the sibling `unit` property
discount__trial__unit STRING Temporal unit of the free trial
duration STRING
expired_at TIMESTAMP
free_trial_amount FLOAT64
free_trial_unit STRING
hosted_page_description STRING
id STRING
invoice_description STRING
max_redemptions FLOAT64
max_redemptions_per_account FLOAT64
name STRING
object STRING
redeem_by STRING
redemption_resource STRING
state STRING
temporal_amount FLOAT64
temporal_unit STRING
unique_code_template STRING
unique_coupon_code__bulk_coupon_code STRING The Coupon code of the parent Bulk Coupon
unique_coupon_code__bulk_coupon_id STRING The Coupon ID of the parent Bulk Coupon
unique_coupon_code__code STRING The code the customer enters to redeem the coupon.
unique_coupon_code__created_at TIMESTAMP
unique_coupon_code__expired_at TIMESTAMP The date and time the coupon was expired early or reached its `max_redemptions`.
unique_coupon_code__id STRING
unique_coupon_code__object STRING
unique_coupon_code__redeemed_at TIMESTAMP The date and time the unique coupon code was redeemed.
unique_coupon_code__state STRING Indicates if the unique coupon code is redeemable or why not.
unique_coupon_code__updated_at TIMESTAMP
unique_coupon_codes_count FLOAT64
updated_at TIMESTAMP
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.

Repeating fields are split into their own tables, listed here with their column counts.

  • coupons__discount__currencies (5 columns)
  • coupons__items (4 columns)
  • coupons__plans (5 columns)
credit_payments (19 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
account__code STRING The unique identifier of the account.
account__id STRING The ID of the account associated with the credit payment.
action STRING The action for which the credit was created.
amount FLOAT64 Total credit payment amount applied to the charge invoice.
applied_to_invoice__id STRING The ID of the invoice to which the credit payment is applied.
applied_to_invoice__number STRING The number of the invoice to which the credit payment is applied.
created_at TIMESTAMP The date and time when the credit payment was created.
currency STRING 3-letter ISO 4217 currency code.
id STRING The unique identifier of the credit payment.
original_credit_payment_id STRING For credit payments with action `refund`, this is the credit payment that was refunded.
original_invoice__id STRING The ID of the original invoice for which the credit payment was made.
original_invoice__number STRING The number of the original invoice for which the credit payment was made.
refund_transaction__id STRING The ID of the refund transaction associated with the credit payment.
refund_transaction__uuid STRING The UUID is useful for matching data with the CSV exports and building URLs into Recurly’s UI.
updated_at TIMESTAMP The date and time when the credit payment was last updated.
uuid STRING The UUID is useful for matching data with the CSV exports and building URLs into Recurly’s UI.
voided_at TIMESTAMP The date and time when the credit payment was voided.
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.
export_dates (2 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.

Repeating fields are split into their own tables, listed here with their column counts.

  • export_dates__dates (4 columns)
invoices (61 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
type STRING Invoices are either charge, credit, or legacy invoices.
account__bill_to STRING
account__code STRING
account__company STRING
account__dunning_campaign_id STRING
account__email STRING
account__first_name STRING
account__id STRING
account__last_name STRING
account__object STRING
account__parent_account_id STRING
address__city STRING The city in the address.
address__company STRING The company name in the address.
address__country STRING Country, 2-letter ISO 3166-1 alpha-2 code.
address__first_name STRING The first name of the recipient.
address__last_name STRING The last name of the recipient.
address__name_on_account STRING The name on the account.
address__phone STRING The phone number associated with the address.
address__postal_code STRING Zip or postal code.
address__region STRING State or province.
address__street1 STRING The first line of the street address.
address__street2 STRING The second line of the street address.
balance FLOAT64 The outstanding balance remaining on this invoice.
billing_info_id STRING The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.
business_entity_id STRING The business entity ID linked to the invoice.
closed_at TIMESTAMP Date invoice was marked paid or failed.
collection_method STRING An automatic invoice means a corresponding transaction is run using the account’s billing information at the same time the invoice is created. Manual invoices are created without a corresponding transaction. The merchant must enter a manual payment transaction or have the customer pay the invoice with an automatic method, like credit card, PayPal, Amazon, or ACH bank payment.
created_at TIMESTAMP The date and time when the invoice was created.
currency STRING 3-letter ISO 4217 currency code.
customer_notes STRING This will default to the Customer Notes text specified on the Invoice Settings. Specify custom notes to add or override Customer Notes.
discount FLOAT64 Total discounts applied to this invoice.
due_at TIMESTAMP Date invoice is due. This is the date the net terms are reached.
dunning_campaign_id STRING Unique ID to identify the dunning campaign used when dunning the invoice. Available when the Dunning Campaigns feature is enabled. For sites without multiple dunning campaigns enabled, this will always be the default dunning campaign.
dunning_events_sent INT64 The number of dunning events sent for the invoice.
final_dunning_event BOOL The final dunning event related to the invoice if applicable.
has_more_line_items BOOL Indicates if there are more line items in the invoice.
id STRING The unique ID of the invoice.
net_terms INT64 Integer representing the number of days after an invoice’s creation that the invoice will become past due. If an invoice’s net terms are set to ‘0’, it is due ‘On Receipt’ and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.
number STRING If VAT taxation and the Country Invoice Sequencing feature are enabled, invoices will have country-specific invoice numbers for invoices billed to EU countries (ex: FR1001). Non-EU invoices will continue to use the site-level invoice number sequence.
object STRING The type of object, in this case, an invoice.
origin STRING The event that created the invoice.
paid FLOAT64 The total amount of successful payments transaction on this invoice.
po_number STRING For manual invoicing, this identifies the PO number associated with the subscription.
previous_invoice_id STRING On refund invoices, this value will exist and show the invoice ID of the purchase invoice the refund was created from.
refundable_amount FLOAT64 The refundable amount on a charge invoice. It will be null for all other invoices.
shipping_address__id STRING The ID of the shipping address.
state STRING The current state of the invoice.
subtotal FLOAT64 The summation of charges and credits, before discounts and taxes.
tax FLOAT64 The total tax on this invoice.
tax_info__type STRING Provides the tax type as “vat” for EU VAT, “usst” for U.S. Sales Tax, or the 2 letter country code for country level tax types like Canada, Australia, New Zealand, Israel, and all non-EU European countries.
tax_info__rate FLOAT64 The tax rate applied to the invoice.
tax_info__region STRING Provides the tax region applied on an invoice. For U.S. Sales Tax, this will be the 2 letter state code. For EU VAT this will be the 2 letter country code. For all country level tax types, this will display the regional tax, like VAT, GST, or PST.
terms_and_conditions STRING This will default to the Terms and Conditions text specified on the Invoice Settings page in your Recurly admin. Specify custom notes to add or override Terms and Conditions.
total FLOAT64 The final total on this invoice. The summation of invoice charges, discounts, credits, and tax.
updated_at TIMESTAMP The date and time when the invoice was last updated.
used_tax_service BOOL Indicates if a tax service was used for the invoice.
uuid STRING The universally unique identifier (UUID) of the invoice.
vat_number STRING VAT registration number for the customer on this invoice. This will come from the VAT Number field in the Billing Info or the Account Info depending on your tax settings and the invoice collection method.
vat_reverse_charge_notes STRING VAT Reverse Charge Notes only appear if you have EU VAT enabled or are using your own Avalara AvaTax account and the customer is in the EU, has a VAT number, and is in a different country than your own. This will default to the VAT Reverse Charge Notes text specified on the Tax Settings page in your Recurly admin, unless custom notes were created with the original subscription.
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.

Repeating fields are split into their own tables, listed here with their column counts.

  • invoices__credit_payments (5 columns)
  • invoices__line_items (61 columns)
  • invoices__line_items__custom_fields (5 columns)
  • invoices__line_items__tax_info__tax_details (10 columns)
  • invoices__subscription_ids (4 columns)
  • invoices__tax_info__tax_details (7 columns)
  • invoices__transactions (5 columns)
line_items (60 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
type STRING Charges are positive line items that debit the account. Credits are negative line items that credit the account.
description STRING Description that appears on the invoice. For subscription related items this will be filled in automatically.
account__bill_to STRING
account__code STRING
account__company STRING
account__dunning_campaign_id STRING
account__email STRING
account__first_name STRING
account__id STRING
account__last_name STRING
account__object STRING
account__parent_account_id STRING
accounting_code STRING Internal accounting code to help you reconcile your revenue to the correct ledger. Line items created as part of a subscription invoice will use the plan or add-on’s accounting code, otherwise the value will only be present if you define an accounting code when creating the line item.
add_on_code STRING If the line item is a charge or credit for an add-on, this is its code.
add_on_id STRING If the line item is a charge or credit for an add-on this is its ID.
amount FLOAT64 `(quantity * unit_amount) - (discount + tax)`
bill_for_account_id STRING The UUID of the account responsible for originating the line item.
created_at TIMESTAMP When the line item was created.
credit_applied FLOAT64 The amount of credit from this line item that was applied to the invoice.
credit_reason_code STRING The reason the credit was given when line item is `type=credit`.
currency STRING 3-letter ISO 4217 currency code.
discount FLOAT64 The discount applied to the line item.
end_date TIMESTAMP If this date is provided, it indicates the end of a time range.
external_sku STRING Optional Stock Keeping Unit assigned to an item. Available when the Credit Invoices and Subscription Billing Terms features are enabled.
id STRING
invoice_id STRING Once the line item has been invoiced this will be the invoice’s ID.
invoice_number STRING Once the line item has been invoiced this will be the invoice’s number. If VAT taxation and the Country Invoice Sequencing feature are enabled, invoices will have country-specific invoice numbers for invoices billed to EU countries (ex: FR1001). Non-EU invoices will continue to use the site-level invoice number sequence.
item_code STRING Unique code to identify an item. Available when the Credit Invoices and Subscription Billing Terms features are enabled.
item_id STRING System-generated unique identifier for an item. Available when the Credit Invoices and Subscription Billing Terms features are enabled.
legacy_category STRING Category to describe the role of a line item on a legacy invoice:- “charges” refers to charges being billed for on this invoice.- “credits” refers to refund or proration credits. This portion of the invoice can be considered a credit memo.- “applied_credits” refers to previous credits applied to this invoice. See their original_line_item_id to determine where the credit first originated.- “carryforwards” can be ignored. They exist to consume any remaining credit balance. A new credit with the same amount will be created and placed back on the account.
object STRING
origin STRING A credit created from an original charge will have the value of the charge’s origin.
original_line_item_invoice_id STRING The invoice where the credit originated. Will only have a value if the line item is a credit created from a previous credit, or if the credit was created from a charge refund.
plan_code STRING If the line item is a charge or credit for a plan or add-on, this is the plan’s code.
plan_id STRING If the line item is a charge or credit for a plan or add-on, this is the plan’s ID.
previous_line_item_id STRING Will only have a value if the line item is a credit created from a previous credit, or if the credit was created from a charge refund.
product_code STRING For plan-related line items this will be the plan’s code, for add-on related line items it will be the add-on’s code. For item-related line items it will be the item’s `external_sku`.
proration_rate FLOAT64 When a line item has been prorated, this is the rate of the proration. Proration rates were made available for line items created after March 30, 2017. For line items created prior to that date, the proration rate will be `null`, even if the line item was prorated.
quantity INT64 This number will be multiplied by the unit amount to compute the subtotal before any discounts or taxes.
refund BOOL
refunded_quantity INT64 For refund charges, the quantity being refunded. For non-refund charges, the total quantity refunded (possibly over multiple refunds).
revenue_schedule_type STRING
shipping_address__id STRING
start_date TIMESTAMP If an end date is present, this is value indicates the beginning of a billing time range. If no end date is present it indicates billing for a specific date.
state STRING Pending line items are charges or credits on an account that have not been applied to an invoice yet. Invoiced line items will always have an `invoice_id` value.
subscription_id STRING If the line item is a charge or credit for a subscription, this is its ID.
subtotal FLOAT64 `quantity * unit_amount`
tax FLOAT64 The tax amount for the line item.
tax_code STRING Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
tax_exempt BOOL `true` exempts tax on charges, `false` applies tax on charges. If not defined, then defaults to the Plan and Site settings. This attribute does not work for credits (negative line items). Credits are always applied post-tax. Pre-tax discounts should use the Coupons feature.
tax_info__type STRING
tax_info__rate FLOAT64
tax_info__region STRING
taxable BOOL `true` if the line item is taxable, `false` if it is not.
unit_amount FLOAT64 Positive amount for a charge, negative amount for a credit.
unit_amount_decimal STRING Positive amount for a charge, negative amount for a credit.
updated_at TIMESTAMP When the line item was last changed.
uuid STRING The UUID is useful for matching data with the CSV exports and building URLs into Recurly’s UI.
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.

Repeating fields are split into their own tables, listed here with their column counts.

  • line_items__custom_fields (5 columns)
  • line_items__tax_info__tax_details (10 columns)
measured_units (11 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
description STRING Description of the measured unit
created_at TIMESTAMP Timestamp indicating when the measured unit was created
deleted_at TIMESTAMP Timestamp indicating when the measured unit was deleted (if applicable)
display_name STRING Human-readable name used for display purposes
id STRING Unique identifier for the measured unit
name STRING Internal name used to identify the measured unit
object STRING Type of object, in this case, ‘measured_unit’
state STRING Current state of the measured unit
updated_at TIMESTAMP Timestamp indicating when the measured unit was last updated
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.
plans (33 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
description STRING Description of the plan.
accounting_code STRING The accounting code associated with the plan.
allow_any_item_on_subscriptions BOOL Determines if any item can be added to subscriptions using this plan.
auto_renew BOOL Indicates whether the plan should automatically renew.
avalara_service_type FLOAT64 The Avalara service type used for tax calculation.
avalara_transaction_type FLOAT64 The Avalara transaction type used for tax calculation.
code STRING Unique identifier code for the plan.
created_at TIMESTAMP Timestamp indicating when the plan was created.
deleted_at TIMESTAMP Timestamp indicating when the plan was deleted.
dunning_campaign_id STRING ID of the dunning campaign associated with the plan.
hosted_pages__bypass_confirmation BOOL Determines if confirmation is bypassed on hosted pages.
hosted_pages__cancel_url STRING URL to redirect when a user cancels during hosted page process.
hosted_pages__display_quantity BOOL Determines if quantity is displayed on hosted pages.
hosted_pages__success_url STRING URL to redirect when a user successfully completes hosted page process.
id STRING Unique identifier of the plan.
interval_length FLOAT64 Length of the billing interval for the plan.
interval_unit STRING Unit of the billing interval for the plan.
name STRING Name of the plan.
object STRING Indicates the type of object which in this case is ‘plan’.
pricing_model STRING The pricing model used for the plan.
revenue_schedule_type STRING Type of revenue schedule for the plan.
setup_fee_accounting_code STRING The accounting code associated with the setup fee.
setup_fee_revenue_schedule_type STRING Revenue schedule type for the setup fee.
state STRING The current state of the plan.
tax_code STRING Tax code used for the plan.
tax_exempt BOOL Determines if the plan is tax exempt.
total_billing_cycles FLOAT64 Total number of billing cycles the plan will run for.
trial_length FLOAT64 Length of the trial period for the plan.
trial_requires_billing_info BOOL Determines if billing information is required for the trial.
trial_unit STRING Unit of the trial period for the plan.
updated_at TIMESTAMP Timestamp indicating when the plan was last updated.
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.

Repeating fields are split into their own tables, listed here with their column counts.

  • plans__currencies (6 columns)
  • plans__custom_fields (5 columns)
  • plans__ramp_intervals (4 columns)
  • plans__ramp_intervals__currencies (5 columns)
shipping_addresses (21 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
account_id STRING
city STRING
company STRING
country STRING Country, 2-letter ISO 3166-1 alpha-2 code.
created_at TIMESTAMP
email STRING
first_name STRING
geo_code STRING
id STRING
last_name STRING
nickname STRING
object STRING
phone STRING
postal_code STRING Zip or postal code.
region STRING State or province.
street1 STRING
street2 STRING
updated_at TIMESTAMP
vat_number STRING
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.
shipping_methods (10 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
accounting_code STRING Accounting code for shipping method.
code STRING The internal name used identify the shipping method.
created_at TIMESTAMP Timestamp indicating when the shipping method was created
deleted_at TIMESTAMP Timestamp indicating when the shipping method was deleted
id STRING Unique identifier for the shipping method
name STRING The name of the shipping method displayed to customers.
tax_code STRING Used by Avalara, Vertex, and Recurly’s built-in tax feature. The taxcode values are specific to each tax system. If you are using Recurly’sbuilt-in taxes the values are:- `FR` – Common Carrier FOB Destination- `FR022000` – Common Carrier FOB Origin- `FR020400` – Non Common Carrier FOB Destination- `FR020500` – Non Common Carrier FOB Origin- `FR010100` – Delivery by Company Vehicle Before Passage of Title- `FR010200` – Delivery by Company Vehicle After Passage of Title- `NT` – Non-Taxable
updated_at TIMESTAMP Timestamp indicating when the shipping method was last updated
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.
subscriptions (110 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
account__bill_to STRING
account__code STRING
account__company STRING
account__dunning_campaign_id STRING
account__email STRING
account__first_name STRING
account__id STRING
account__last_name STRING
account__object STRING
account__parent_account_id STRING
activated_at TIMESTAMP Timestamp when the subscription was activated
active_invoice_id STRING ID of the active invoice associated with the subscription.
add_ons_total FLOAT64 Total amount charged for the additional services or items.
auto_renew BOOL Flag indicating whether the subscription auto renews.
bank_account_authorized_at TIMESTAMP Timestamp when bank account authorization occurred
billing_info_id STRING ID of the billing information associated with the subscription.
canceled_at TIMESTAMP Timestamp when the subscription was canceled
collection_method STRING Method used for collecting payments for the subscription.
converted_at TIMESTAMP Timestamp when the subscription was converted
coupon_redemptions__coupon__code STRING
coupon_redemptions__coupon__coupon_type STRING
coupon_redemptions__coupon__discount__type STRING
coupon_redemptions__coupon__discount__percent INT64
coupon_redemptions__coupon__discount__trial__length INT64
coupon_redemptions__coupon__discount__trial__unit STRING
coupon_redemptions__coupon__expired_at TIMESTAMP
coupon_redemptions__coupon__id STRING
coupon_redemptions__coupon__name STRING
coupon_redemptions__coupon__object STRING
coupon_redemptions__coupon__state STRING
coupon_redemptions__created_at TIMESTAMP
coupon_redemptions__discounted FLOAT64
coupon_redemptions__id STRING
coupon_redemptions__object STRING
coupon_redemptions__state STRING
created_at TIMESTAMP Timestamp when the subscription was created
currency STRING Currency used for billing the subscription.
current_period_ends_at TIMESTAMP Timestamp when the current period ends
current_period_started_at TIMESTAMP Timestamp when the current period started
current_term_ends_at TIMESTAMP Timestamp when the current term ends
current_term_started_at TIMESTAMP Timestamp when the current term started
customer_notes STRING Any notes or comments added by the customer.
expiration_reason STRING Reason for the subscription expiration.
expires_at TIMESTAMP Timestamp when the subscription expires
gateway_code STRING Code associated with the payment gateway used for processing payments.
id STRING Unique identifier for the subscription.
net_terms FLOAT64 Number of net terms for payment.
net_terms_type STRING Type of net terms (e.g., days).
object STRING Indicates the type of object (subscription).
paused_at TIMESTAMP Timestamp when the subscription was paused
pending_change__activate_at TIMESTAMP Timestamp when the pending change will be activated
pending_change__activated BOOL Returns `true` if the subscription change is activated.
pending_change__created_at TIMESTAMP Timestamp when the pending change was created
pending_change__deleted_at TIMESTAMP Timestamp when the pending change was deleted
pending_change__id STRING The ID of the Subscription Change.
pending_change__subscription_id STRING The ID of the subscription that is going to be changed.
pending_change__updated_at TIMESTAMP Timestamp when the pending change was last updated
plan__code STRING
plan__id STRING
plan__name STRING
plan__object STRING
po_number STRING Purchase order number associated with the subscription.
quantity FLOAT64 Number of units or items included in the subscription.
remaining_billing_cycles FLOAT64 Number of billing cycles remaining before subscription ends.
remaining_pause_cycles FLOAT64 Number of pause cycles remaining for the subscription.
renewal_billing_cycles FLOAT64 Number of billing cycles in the renewal period.
revenue_schedule_type STRING Type of revenue schedule for the subscription.
shipping__address__account_id STRING
shipping__address__city STRING
shipping__address__company STRING
shipping__address__country STRING Country, 2-letter ISO 3166-1 alpha-2 code.
shipping__address__created_at TIMESTAMP
shipping__address__email STRING
shipping__address__first_name STRING
shipping__address__geo_code STRING
shipping__address__id STRING
shipping__address__last_name STRING
shipping__address__nickname STRING
shipping__address__object STRING
shipping__address__phone STRING
shipping__address__postal_code STRING Zip or postal code.
shipping__address__region STRING State or province.
shipping__address__street1 STRING
shipping__address__street2 STRING
shipping__address__updated_at TIMESTAMP
shipping__address__vat_number STRING
shipping__amount FLOAT64
shipping__method__code STRING
shipping__method__id STRING
shipping__method__name STRING
shipping__method__object STRING
shipping__object STRING
started_with_gift BOOL Indicates if the subscription started with a gift or promotion.
state STRING Current state of the subscription (e.g., active, cancelled).
subtotal FLOAT64 Subtotal amount before taxes and additional charges.
tax FLOAT64 Total tax amount applied to the subscription.
tax_inclusive BOOL Flag indicating if taxes are included in the total amount.
tax_info__type STRING
tax_info__rate FLOAT64
tax_info__region STRING
terms_and_conditions STRING Terms and conditions agreed upon for the subscription.
total FLOAT64 Total amount including taxes and additional charges.
total_billing_cycles FLOAT64 Total number of billing cycles for the subscription.
trial_ends_at TIMESTAMP Timestamp when the trial period ends
trial_started_at TIMESTAMP Timestamp when the trial period started
unit_amount FLOAT64 Amount charged per unit for the subscription.
updated_at TIMESTAMP Timestamp when the subscription was last updated
uuid STRING Universally unique identifier for the subscription.
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.

Repeating fields are split into their own tables, listed here with their column counts.

  • subscriptions__add_ons (5 columns)
  • subscriptions__coupon_redemptions__coupon__discount__currencies (5 columns)
  • subscriptions__custom_fields (5 columns)
  • subscriptions__ramp_intervals (8 columns)
  • subscriptions__tax_info__tax_details (10 columns)
transactions (88 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
type STRING Type of transaction
account__bill_to STRING
account__code STRING
account__company STRING
account__dunning_campaign_id STRING
account__email STRING
account__first_name STRING
account__id STRING
account__last_name STRING
account__object STRING
account__parent_account_id STRING
amount FLOAT64 Amount of the transaction
avs_check STRING Result of the Address Verification System check
backup_payment_method_used BOOL Indicates whether a backup payment method was used
billing_address__city STRING
billing_address__country STRING
billing_address__first_name STRING
billing_address__geo_code STRING
billing_address__last_name STRING
billing_address__phone STRING
billing_address__postal_code STRING
billing_address__region STRING
billing_address__street1 STRING
billing_address__street2 STRING
collected_at TIMESTAMP Date and time when the transaction was collected
collection_method STRING Method used to collect the transaction
created_at TIMESTAMP Date and time when the transaction was created
currency STRING Currency used for the transaction
customer_message STRING Message for the customer related to the transaction
customer_message_locale STRING Locale of the customer message
cvv_check STRING Result of the CVV check
fraud_info__decision STRING
fraud_info__object STRING
fraud_info__reference STRING
fraud_info__score INT64
gateway_approval_code STRING Approval code provided by the payment gateway
gateway_message STRING Message returned by the payment gateway
gateway_reference STRING Reference number provided by the payment gateway
gateway_response_code STRING Response code from the payment gateway
gateway_response_time FLOAT64 Time taken for the payment gateway to respond
id STRING Unique identifier for the transaction
invoice__type STRING
invoice__business_entity_id STRING
invoice__id STRING
invoice__number STRING
invoice__state STRING
ip_address_country STRING Country of the IP address used for the transaction
ip_address_v4 STRING IPv4 address of the transaction
object STRING Type of object (transaction)
origin STRING Source or origin of the transaction
original_transaction_id STRING ID of the original transaction, if applicable
payment_gateway__type STRING
payment_gateway__id STRING
payment_gateway__name STRING
payment_gateway__object STRING
payment_method__account_type STRING
payment_method__billing_agreement_id STRING
payment_method__card_type STRING
payment_method__cc_bin_country STRING
payment_method__exp_month FLOAT64
payment_method__exp_year FLOAT64
payment_method__first_six STRING
payment_method__gateway_code STRING
payment_method__gateway_token STRING
payment_method__last_four STRING
payment_method__last_two STRING
payment_method__name_on_account STRING
payment_method__object STRING
payment_method__routing_number STRING
payment_method__routing_number_bank STRING
payment_method__username STRING
refunded BOOL Indicates whether the transaction has been refunded
status STRING Current status of the transaction
status_code STRING Status code of the transaction
status_message STRING Message related to the status of the transaction
success BOOL Indicates the success status of the transaction
updated_at TIMESTAMP Date and time of the last update to the transaction
uuid STRING Universally unique identifier for the transaction
vat_number STRING VAT number associated with the transaction
voided_at TIMESTAMP Date and time when the transaction was voided
voided_by_invoice__type STRING
voided_by_invoice__business_entity_id STRING
voided_by_invoice__id STRING
voided_by_invoice__number STRING
voided_by_invoice__object STRING
voided_by_invoice__state STRING
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.

Repeating fields are split into their own tables, listed here with their column counts.

  • transactions__fraud_info__risk_rules_triggered (5 columns)
  • transactions__subscription_ids (4 columns)
unique_coupons (12 columns), A unique coupon code for a bulk coupon.
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
bulk_coupon_code STRING The Coupon code of the parent Bulk Coupon
bulk_coupon_id STRING The Coupon ID of the parent Bulk Coupon
code STRING The code the customer enters to redeem the coupon.
created_at TIMESTAMP
expired_at TIMESTAMP The date and time the coupon was expired early or reached its `max_redemptions`.
id STRING
object STRING
redeemed_at TIMESTAMP The date and time the unique coupon code was redeemed.
state STRING Indicates if the unique coupon code is redeemable or why not.
updated_at TIMESTAMP
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.
unique_coupons_parent (21 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
applies_to_all_items BOOL
applies_to_all_plans BOOL
applies_to_non_plan_charges BOOL
code STRING
coupon_type STRING
created_at STRING
discount__type STRING
duration STRING
hosted_page_description STRING
id STRING
invoice_description STRING
max_redemptions_per_account FLOAT64
name STRING
object STRING
redemption_resource STRING
state STRING
unique_code_template STRING
unique_coupon_codes_count FLOAT64
updated_at STRING
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.

Repeating fields are split into their own tables, listed here with their column counts.

  • unique_coupons_parent__discount__currencies (5 columns)

After the first load, Kaivo keeps your BigQuery warehouse up to date for you. Where Recurly supports it, each sync pulls only new and changed records so it stays fast; otherwise it refreshes the whole table. Every record keeps its original ID, so you won’t get duplicate rows.

How long does the initial sync take for Recurly?

Section titled “How long does the initial sync take for Recurly?”

It depends on how much history is in your Recurly account. Most initial syncs finish within minutes, while large accounts can take a few hours. After that, syncs only fetch new and changed records, so they’re much faster.

Yes. You pick which tables to sync when you set up the connection and can change the selection later. Tables you don’t select are never copied to your warehouse.

What happens when Recurly’s schema changes?

Section titled “What happens when Recurly’s schema changes?”

New fields are never added automatically. You choose which fields to sync, so data you haven’t selected (sensitive personal data, for example) never lands in your warehouse. When a new field appears, it becomes available for you to add. What happens to removed or renamed fields depends on a table’s sync mode: full-refresh tables always match what’s currently in Recurly, so dropped fields disappear, while incremental tables keep their existing columns and history, so an old field stays and newly added fields fill in over time.

How do I handle GDPR or data deletion requests?

Section titled “How do I handle GDPR or data deletion requests?”

Your data lives in your own Kaivo-managed BigQuery warehouse, so the most direct option is to delete or anonymise specific records right in BigQuery. If you delete data in Recurly instead, full-refresh tables drop it on the next sync, while incremental tables keep it, so you would remove the row in BigQuery or ask us to run a full refresh. To remove everything, delete the Recurly connector in Kaivo and all of its synced data is deleted with it.

Use subscriptions and invoices to track MRR, expansion, and churn over time.

Join invoices with transactions and credit_payments to reconcile billing.

Use plans and add_ons to see which plans drive revenue and upgrades.

Bring coupons and account_coupon_redemptions into BigQuery to measure discount use.

Once Recurly data lands in your Kaivo-managed BigQuery warehouse, you can explore it with AI tools or any BI tool that connects to BigQuery. Here’s how the most common destinations work with Recurly data.

Use Kaivo’s MCP server to give Claude secure, workspace-scoped access to your data. Setup guide →

Microsoft’s BI tool with a native BigQuery connector. Supports direct query and scheduled refresh. Setup guide →

Free Google BI tool with native BigQuery support. One-click connection to your Kaivo warehouse; great for SMB teams on Google Workspace. Setup guide →

The premium analytics standard, with native BigQuery integration. Setup guide →

Use Connected Sheets to query BigQuery directly from a spreadsheet, with no SQL. Setup guide →

Connect via Power Query’s BigQuery connector. Setup guide →

Open-source BI tool with strong BigQuery support. Setup guide →

See our pricing page for Recurly connector pricing and plan details.