Recurly integration summary

Stitch’s Recurly integration replicates data using the Recurly Partner API (v2018-08-09). Refer to the Schema section for a list of objects available for replication.

Recurly feature snapshot

A high-level look at Stitch's Recurly (v1.0) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release Status

Open Beta

 Supported By

Stitch
Stitch Plan

Paid

 Singer GitHub Repository

Recurly Repository

DATA SELECTION
Table Selection

Supported

 Column Selection

Supported
REPLICATION SETTINGS
Anchor Scheduling

Supported

 Advanced Scheduling

Unsupported
Table-level Reset

Unsupported

 Configurable Replication Methods

Unsupported
TRANSPARENCY
Extraction Logs

Supported

 Loading Reports

Supported

Connecting Recurly

Recurly setup requirements

To set up Recurly in Stitch, you need:

  • A paid Stitch plan. While those currently in the Free Trial will also be able to set up Recurly, replication will be paused until a paid plan is selected after the trial ends.

  • Admin or Manager permissions in Recurly. These permissions are required to create an API key for Stitch.

Step 1: Generate a Recurly API key

In this step, you’ll create an API key for Stitch.

  1. Sign into your Recurly account.
  2. Click Admin > Users in the sidenav.
  3. On the Users page, click the Configure API Access button at the top of the page. Thsi will open the API Credentials page.
  4. Click the Add Private API Key button. The Add Private API Key page will display.
  5. Fill in the fields as follows:
    • Key Name: Enter a name for the API key. For example: Stitch
    • Notes: Enter any notes you want about the API key.
  6. Click Save Changes.

Leave this page open for now - you’ll need it to complete the setup in Stitch.

Step 2: Add Recurly as a Stitch data source

  1. Sign into your Stitch account.

  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the Recurly icon.

  4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

    For example, the name “Stitch Recurly” would create a schema called stitch_recurly in the destination. Note: Schema names cannot be changed after you save the integration.

  5. In the API Key field, paste the Recurly API key you created in Step 1.
  6. In the Recurly Subdomain field, enter your Recurly subdomain. For example: If the full URL of the subdomain were stitchdata.recurly.com, you’d only enter stitchdata into this field.
  7. In the Quota Limit field, enter the percentage of the API rate limit you want to allocate to the integration. For example: A value of 30 would be 30% of the rate limit. Refer to Recurly’s documentation for more info.

Step 3: Define the historical sync

The Sync Historical Data setting will define the starting date for your Recurly integration. This means that data equal to or newer than this date will be replicated to your data warehouse.

Change this setting if you want to replicate data beyond Recurly’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 4: Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Recurly integrations support the following replication scheduling methods:

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 5: Set tables and columns to replicate

To complete the setup, you’ll need to select the tables and columns you want to replicate to your data warehouse.

Check out the Schema section to learn more about the available tables in Recurly and how they replicate.

  1. In the list of tables that displays - or in the Tables to Replicate tab, if you skipped this step during setup - locate a table you want to replicate.

  2. To track a table, click the checkbox next to the table’s name. A green checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A green checkmark means the column is set to replicate.

  4. Repeat this process for all the tables and columns you want to replicate.
  5. When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.

Note: If you change these settings while a replication job is still in progress, they will not be used until the next job starts.

Initial and historical replication jobs

After you finish setting up Recurly, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

Recurly table schemas

accounts

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

id

 API endpoint :

List a site’s accounts

The accounts table contains info about the customer accounts in your Recurly account. Account objects store the history of the customer, billing info, etc.

Custom fields

Stitch’s Recurly integration supports replicating custom fields for accounts objects.

accounts table schema

id
STRING

The account ID.

Reference:

updated_at
DATE-TIME

The date and time the account or its billing info was last updated.

address
OBJECT

The address info for the account.

Click to expand address

city
STRING

The city.

country
STRING

The country.

first_name
STRING

The first name on the address.

last_name
STRING

The last name on the address.

phone
STRING

The phone number.

postal_code
STRING

The postal code.

region
STRING

The region.

street1
STRING

The first street line.

street2
STRING

The second street line.
accounts (table), address (attribute)

bill_to
STRING

Indicates whether charges on the account are billed using the parent’s billing info or the account itself. Possible values are:

  • self - The account itself.
  • parent - All invoices resulting in charges and credits originating from a child will be created on the parent account.

billing_info
OBJECT

Details about the account’s billing info.

Click to expand billing_info

account_id
STRING

The ID of the account associated with the billing info.

address
OBJECT

The address associated with the billing info.

Click to expand address

city
STRING

The city.

country
STRING

The country.

first_name
STRING

The first name on the address.

last_name
STRING

The last name on the address.

phone
STRING

The phone number.

postal_code
STRING

The postal code.

region
STRING

The region.

street1
STRING

The first street line.

street2
STRING

The second street line.
accounts (table), address (attribute)

company
STRING

The billing company.

created_at
DATE-TIME

The timestamp when the billing info was created.

first_name
STRING

The first name.

fraud
OBJECT

Details about the most recent fraud result.

Click to expand fraud

decision
STRING

The fraud result decision. Possible values are:

  • approve
  • review
  • decline
  • escalate

risk_rules_triggered
OBJECT

score
INTEGER

The fraud result score. The value will be a number between 1 and 99.
accounts (table), fraud (attribute)

id
STRING

the billing info ID.

last_name
STRING

The last name.

object
STRING

payment_method
OBJECT

Details about the payment method associated with the account’s billing info.

Click to expand payment_method

card_type
STRING

The card type. Possible values include:

  • American Express
  • Dankort
  • Diners Club
  • Discover
  • Forbrugsforeningen
  • JCB
  • Laser
  • Maestro
  • MasterCard
  • Test Card
  • Unknown
  • Visa

exp_month
INTEGER

The expiration month for the card.

exp_year
INTEGER

The expiration year for the card.

first_six
STRING

The first six digits of the credit card’s number.

last_four
STRING

The last four digits of the credit card’s number.

object
STRING

accounts (table), payment_method (attribute)

updated_at
DATE-TIME

The timestamp when the billing info was last updated.

updated_by
OBJECT

Details about the user who last updated the billing info for the account.

Click to expand updated_by

country
STRING

The two-letter ISO country code of the user who last updated the billing info, based on their ip.

ip
STRING

The IPv4 address of the user who last updated the billing info.
accounts (table), updated_by (attribute)

valid
BOOLEAN

Indicates if the billing info is valid.

vat_number
STRING

The customer’s VAT number.
accounts (table), billing_info (attribute)

cc_emails
STRING

Additional email addresses that should receive account correspondence. These emails will receive all emails that the email field also receives.

code
STRING

The unique identifier of the account.

company
STRING

The company name of the account.

created_at
DATE-TIME

The date and time the account was created.

custom_fields
ARRAY

A list of custom fields associated with the account.

Click to expand custom_fields

name
STRING

The name of the custom field.

value
STRING

The value of the custom field.
accounts (table), custom_fields (attribute)

deleted_at
DATE-TIME

The date and time the account was deleted.

email
STRING

The email address for the account.

exemption_certificate
STRING

The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.

first_name
STRING

The first name of the account.

hosted_login_token
STRING

The unique token for automatically logging the account into the hosted management pages.

last_name
STRING

The last name of the account.

object
STRING

This will be account.

parent_account_id
STRING

If the account is a child account, the ID of the parent account.

Reference:

preferred_locale
STRING

Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.

shipping_addresses
ARRAY

The shipping address info for the account.

Click to expand shipping_addresses

account_id
STRING

The ID of the account associated with the shipping address info.

Reference:

city
STRING

The shipping city.

company
STRING

The shipping company.

country
STRING

The two-letter ISO country code.

created_at
DATE-TIME

The timestamp when the shipping address was created.

email
STRING

The email associated with the shipping address.

first_name
STRING

The first name.

id
STRING

The shipping address ID.

last_name
STRING

The last name.

nickname
STRING

The nickname.

phone
STRING

The phone number.

postal_code
STRING

The postal code.

region
STRING

The state or province.

street1
STRING

The first street line of the address.

street2
STRING

The second street line of the address.

updated_at
DATE-TIME

The timestamp when the shipping address was last updated.

vat_number
STRING

The VAT number associated with the shipping address.
accounts (table), shipping_addresses (attribute)

state
STRING

The state of the account. Possible values are active or closed.

tax_exempt
BOOLEAN

The tax status of the account. A value of true exempts tax on the account, and false applies tax.

username
STRING

The username of the account.

vat_number
STRING

The VAT number of the account.

adjustments

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

id

 API endpoint :

List an account’s line items

The adjustments table contains info about adjustments, which are credits and charges associated with your customers.

adjustments table schema

id
STRING

The adjustment ID.

Reference:

updated_at
DATE-TIME

The date and time the adjustment was last updated.

account
OBJECT

Details about the account associated with the adjustment.

Click to expand account

bill_to
STRING

Indicates whether charges on the account are billed using the parent’s billing info or the account itself. Possible values are:

  • self - The account itself.
  • parent - All invoices resulting in charges and credits originating from a child will be created on the parent account.

code
STRING

The unique identifier for the account.

company
STRING

The company.

email
STRING

The email.

first_name
STRING

The first name of the account.

id
STRING

The account ID.

Reference:

last_name
STRING

The last name of the account.

object
STRING

This will be account.

parent_account_id
STRING

If this is a child account, this field will contain the ID of the parent account.

Reference:

adjustments (table), account (attribute)

accounting_code
STRING

The accounting code.

add_on_code
STRING

The code for the add-on the adjustment applies to.

add_on_id
STRING

The ID of the add-on the adjustment applies to.

Reference:

amount
NUMBER

The amount of the adjustment.

created_at
DATE-TIME

The timestamp when the adjustment was created.

credit_applied
NUMBER

The amount of credit from this line item that was applied to the invoice.

credit_reason_code
STRING

The credit reason code associated with the adjustment.

currency
STRING

The three-letter ISO code of the currency used for the adjustment.

description
STRING

A description of the adjustment.

discount
NUMBER

The discount on the adjustment.

end_date
DATE-TIME

The timestamp when the adjustment ended.

invoice_id
STRING

The ID of the invoice associated with the adjustment.

Reference:

invoice_number
STRING

The number of the invoice associated with the adjustment.

legacy_category
STRING

The category to describe the role of a line item on a legacy invoice. Possible values include:

  • 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

The origin of the adjustment to return. Possible values are:

  • plan
  • plan_trial
  • setup_fee
  • add_on
  • add_on_trial
  • one_time
  • debit
  • credit
  • coupon
  • carryforward

original_line_item_invoice_id
STRING

The invoice where the credit originated. This field 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

The plan code the adjustment applies to.

plan_id
STRING

The ID of the plan associated with the adjustment.

Reference:

previous_line_item_id
STRING

This field 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 items, this will be the add-on’s code.

proration_rate
NUMBER

Applicable only to prorated adjustments. This represents how much the adjustment was prorated to account for a mid-cycle subscription change.

quantity
INTEGER

The quantity of the adjustment.

refund
BOOLEAN

Indicates whether the adjustment is a refund or not.

refunded_quantity
INTEGER

The refunded quantity of the adjustment.

shipping_addresses
ARRAY

The shipping address info for the adjustment.

Click to expand shipping_addresses

account_id
STRING

The ID of the account associated with the shipping address info.

Reference:

city
STRING

The shipping city.

company
STRING

The shipping company.

country
STRING

The two-letter ISO country code.

created_at
DATE-TIME

The timestamp when the shipping address was created.

email
STRING

The email associated with the shipping address.

first_name
STRING

The first name.

id
STRING

The shipping address ID.

last_name
STRING

The last name.

nickname
STRING

The nickname.

phone
STRING

The phone number.

postal_code
STRING

The postal code.

region
STRING

The state or province.

street1
STRING

The first street line of the address.

street2
STRING

The second street line of the address.

updated_at
DATE-TIME

The timestamp when the shipping address was last updated.

vat_number
STRING

The VAT number associated with the shipping address.
adjustments (table), shipping_addresses (attribute)

start_date
DATE-TIME

The timestamp when the adjustment began.

state
STRING

The state of the adjustments to return. Possible values are:

  • pending
  • invoiced

subscription_id
STRING

The ID of the subscription associated with the adjustment.

subtotal
NUMBER

The subtotal of the adjustment.

tax
NUMBER

The tax amount for the adjustment.

tax_code
STRING

Applicable only to EU VAT and Avalara AvaTax Pro merchants. The tax code for the adjustment. If using Recurly’s EU VAT feature, possible values include unknown, physical, and digital.

tax_exempt
BOOLEAN

Indicates whether the adjustment is tax exempt or not. If true, tax is exempted on the charge.

tax_info
STRING

taxable
BOOLEAN

Indicates if the adjustment is taxable.

type
STRING

The type of adjustment to return. Possible values are:

  • charge
  • credit

unit_amount
NUMBER

The unit amount for the adjustment, in cents. For type: charge, this will be a positive amount. For type: credit, this will be a negative amount.

uuid
STRING

The unique identifier of the adjustment.

billing_info

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

account_id

 API endpoint :

Fetch an account’s billing information

The billing_info table contains info about the billing information for accounts.

Note: To replicate this table, you must also have the accounts table set to replicate.

Custom fields

Stitch’s Recurly integration supports replicating custom fields for billing info objects.

billing_info table schema

account_id
STRING

The ID of the account associated with the billing info.

Reference:

updated_at
DATE-TIME

The timestamp when the billing info was last updated.

address
OBJECT

The address info for the account.

Click to expand address

city
STRING

The city.

country
STRING

The country.

first_name
STRING

The first name on the address.

last_name
STRING

The last name on the address.

phone
STRING

The phone number.

postal_code
STRING

The postal code.

region
STRING

The region.

street1
STRING

The first street line.

street2
STRING

The second street line.
billing_info (table), address (attribute)

company
STRING

The company name of the account.

created_at
DATE-TIME

The timestamp when the billing info was created.

custom_fields
ARRAY

A list of the custom fields associated with the billing info.

Click to expand custom_fields

name
STRING

The name of the custom field.

value
STRING

The value of the custom field.
billing_info (table), custom_fields (attribute)

exemption_certificate
STRING

The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.

first_name
STRING

The first name of the account.

fraud
OBJECT

Details about the most recent fraud result.

Click to expand fraud

decision
STRING

The fraud result decision. Possible values are:

  • approve
  • review
  • decline
  • escalate

risk_rules_triggered
OBJECT

score
INTEGER

The fraud result score. The value will be a number between 1 and 99.
billing_info (table), fraud (attribute)

id
STRING

The billing info ID.

last_name
STRING

The last name of the account.

object
STRING

payment_method
OBJECT

Details about the payment method associated with the account’s billing info.

Click to expand payment_method

account_type
STRING

The account type.

card_type
STRING

If the payment method is a credit card, this field will contain the type of the credit card. Possible values include:

  • American Express
  • Dankort
  • Diners Club
  • Discover
  • Forbrugsforeningen
  • JCB
  • Laser
  • Maestro
  • MasterCard
  • Test Card
  • Unknown
  • Visa

exp_month
INTEGER

If the payment method is a credit card, this field will contain the expiration month for the credit card.

exp_year
INTEGER

If the payment method is a credit card, this field will contain the expiration year for the credit card.

first_six
STRING

If the payment method is a credit card, this field will contain the first six digits of the credit card number.

last_four
STRING

If the payment method is a credit card, this field will contain the last four digits of the credit card number.

object
STRING

routing_number
INTEGER

If the payment method is a check, this field will contain the routing number associated with the check’s bank account.

routing_number_bank
STRING

billing_info (table), payment_method (attribute)

updated_by
OBJECT

Details about the user who last updated the billing info for the account.

Click to expand updated_by

country
STRING

The two-letter ISO country code of the user who last updated the billing info, based on their ip.

ip
STRING

The IPv4 address of the user who last updated the billing info.
billing_info (table), updated_by (attribute)

valid
BOOLEAN

Indicates if the billing info is valid.

vat_number
STRING

The VAT number associated with the account.

coupons

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

id

 API endpoint :

List a site’s coupons

The coupons table contains info about the coupons available in your Recurly account.

coupons table schema

id
STRING

The coupon ID.

Reference:

updated_at
DATE-TIME

The date and time when the coupon was last updated.

applies_to_all_plans
BOOLEAN

Indicates if the coupon is valid for all plans.

applies_to_non_plan_charges
BOOLEAN

Indicates if the coupon is valid for one-time, non-plan charges.

code
STRING

The code the customer enters to redeem the coupon.

coupon_type
STRING

The type of the coupon. Possible values are:

  • single_code
  • bulk

created_at
DATE-TIME

The timestamp when the coupon was created.

discount
OBJECT

Details of the discount a coupon applies.

Click to expand discount

currencies
ARRAY

Applicable only when type: fixed. The currencies associated with the coupon discount.

Click to expand currencies

amount
NUMBER

The value of the fixed discount that the coupon applies.

currency
STRING

The three-letter ISO 4217 currency code.
coupons (table), currencies (attribute)

percent
INTEGER

Applicable only when type: percent. The percent of the total that is used to calculate the discount.

trial
OBJECT

Applicable only when type: free_trial. Details about the discount for free trials.

Click to expand trial

length
INTEGER

The trial length measured in units, specified by unit.

unit
STRING

The temporal unit of the free trial. Possible values are:

  • day
  • week
  • month
coupons (table), trial (attribute)

type
STRING

The type of discount the coupon applies. Possible values are:

  • percent
  • fixed
  • free_trial
coupons (table), discount (attribute)

duration
STRING

The duration that the coupon will be applied to invoices for. Possible values are:

  • forever
  • single_use - The coupon can be applied only to the first invoice.
  • temporal - The coupon can be applied to invoices for the duration determined by the temporal_unit and temporal_amount attributes.

expired_at
DATE-TIME

The date and time the coupon was expired early or reached its max_redemptions.

free_trial_amount
INTEGER

The duration of time the free_trial_unit is for.

free_trial_unit
STRING

The description of the unit of time the coupon is for. Used with the free_trial_amount attribute to determine the duration of time the coupon is for. Possible values are:

  • day
  • week
  • month

hosted_page_description
STRING

This description will show up when a customer redeems a coupon on your Hosted Payment Pages, or if you choose to show the description on your own checkout page.

invoice_description
STRING

The description of the coupon as it will appear on invoices.

max_redemptions
INTEGER

The maximum number of redemptions for the coupon. The coupon will expire when the maximum redemption is hit.

max_redemptions_per_account
INTEGER

The number of times a specific account can redeem the coupon.

name
STRING

The internal name for the coupon.

object
STRING

plans
STRING

plans_names
ARRAY

A list of plan names that the coupon may be applied to.

Click to expand plans_names

value
ANYTHING

The plan name.
coupons (table), plans_names (attribute)

redeem_by
DATE-TIME

the date and time the coupon will expire and can no longer be redeemed.

redemption_resource
STRING

Indicates if the coupon is for all eligible charges on the account or only a specific subscription. Possible values are:

  • account
  • subscription

state
STRING

The coupon’s redemption status. Possible values are:

  • redeemable
  • maxed_out
  • expired

temporal_amount
INTEGER

Applicable when duration: temporal_amount. The duration that the coupon will be applied to invoices for, calculated as an integer multiplied by temporal_unit.

temporal_unit
STRING

Applicable when duration: temporal_amount. The unit of time used to calculate the duration that the coupon will be applied to invoices for. Possible values are:

  • day
  • week
  • month
  • year

unique_coupon_codes_count
INTEGER

The total number of unique redemptions for the coupon.

invoices

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

id

 API endpoint :

List a site’s invoices

The invoices table contains info about the invoices for a Recurly site. An invoice relates charges, credits, and payments together. When a subscription is created or renewed or a charge is created on the account, Recurly will sum the charges, discount or tax as appropriate, and send the invoice out for collection.

invoices table schema

id
STRING

The invoice ID.

Reference:

updated_at
DATE-TIME

The date and time the invoice was last updated.

account
OBJECT

Details about the account associated with the invoice.

Click to expand account

bill_to
STRING

Indicates whether charges on the account are billed using the parent’s billing info or the account itself. Possible values are:

  • self - The account itself.
  • parent - All invoices resulting in charges and credits originating from a child will be created on the parent account.

code
STRING

The unique identifier for the account.

company
STRING

The company.

email
STRING

The email.

first_name
STRING

The first name of the account.

id
STRING

The account ID.

Reference:

last_name
STRING

The last name of the account.

object
STRING

This will be account.

parent_account_id
STRING

If this is a child account, this field will contain the ID of the parent account.

Reference:

invoices (table), account (attribute)

address
OBJECT

Details about the address associated with the invoice.

Click to expand address

city
STRING

The city.

country
STRING

The country.

first_name
STRING

The first name on the address.

last_name
STRING

The last name on the address.

name_on_account
STRING

The name on the account.

phone
STRING

The phone number.

postal_code
STRING

The postal code.

region
STRING

The region.

street1
STRING

The first street line.

street2
STRING

The second street line.
invoices (table), address (attribute)

balance
NUMBER

The outstanding balance remaining on this invoice.

closed_at
DATE-TIME

The date the invoice was marked paid or failed.

collection_method
STRING

The collection method for the invoice. Possible values are:

  • automatic - A corresponding transaction is run using the account’s billing info at the same time the invoice is created.
  • manual - A corresponding transaction is not created, and the merchant must enter a manual payment transaction or have the customer pay with an automatic method.

created_at
DATE-TIME

The date and time the invoice was created.

credit_payments
ARRAY

Details about the credit payments associated with the invoice.

Click to expand credit_payments

account
OBJECT

Details about the account associated with the credit payment.

Click to expand account

code
STRING

The unique identifier for the account.

company
STRING

The company.

email
STRING

The email.

first_name
STRING

The first name of the account.

id
STRING

The account ID.

Reference:

last_name
STRING

The last name of the account.

object
STRING

This will be account.
invoices (table), account (attribute)

action
STRING

The action for which the credit was created. Possible values are:

  • payment
  • refund
  • reduction
  • write_off

amount
NUMBER

The total credit payment applied to the charge invoice.

applied_to_invoice
OBJECT

Details about the invoice the credit payment was applied to.

Click to expand applied_to_invoice

id
STRING

The invoice ID.

Reference:

number
STRING

The invoice number.

object
STRING

This will be invoice.

state
STRING

The state of the invoice. Possible values are:

  • pending
  • processing
  • past_due
  • paid
  • failed

type
STRING

The type of the invoice. Possible values are:

  • charge
  • credit
  • legacy
invoices (table), applied_to_invoice (attribute)

created_at
DATE-TIME

The date and time the credit payment was created.

currency
STRING

The three-letter ISO 4217 currency code.

id
STRING

The credit payment ID.

object
STRING

original_credit_payment_id
STRING

For credit payments with action: refund, this is the credit payment that was refunded.

original_invoice
OBJECT

Details about the original invoice associated with the credit payment.

Click to expand original_invoice

id
STRING

The invoice ID.

Reference:

number
STRING

The invoice number.

object
STRING

This will be invoice.

state
STRING

The state of the invoice. Possible values are:

  • pending
  • processing
  • past_due
  • paid
  • failed

type
STRING

The type of the invoice. Possible values are:

  • charge
  • credit
  • legacy
invoices (table), original_invoice (attribute)

refund_transaction
OBJECT

Details about the refund transaction the credit payment is associated with.

Click to expand refund_transaction

amount
NUMBER

The amount of the transaction.

account
OBJECT

Details about the account associated with the refund transaction.

Click to expand account

code
STRING

The unique identifier for the account.

company
STRING

The company.

email
STRING

The email.

first_name
STRING

The first name of the account.

id
STRING

The account ID.

Reference:

last_name
STRING

The last name of the account.

object
STRING

This will be account.
invoices (table), account (attribute)

avs_check
STRING

The result from checking the overall AVS on the processed transaction.

billing_address
OBJECT

The billing address detail for the account.

Click to expand billing_address

city
STRING

The city.

country
STRING

The country.

first_name
STRING

The first name on the address.

last_name
STRING

The last name on the address.

name_on_account
STRING

The name on the account.

phone
STRING

The phone number.

postal_code
STRING

The postal code.

region
STRING

The region.

street1
STRING

The first street line.

street2
STRING

The second street line.
invoices (table), billing_address (attribute)

collected_at
DATE-TIME

If collected, the date and time the transaction was collected. Otherwise, the time the transaction was created.

collection_method
STRING

The method by which payment for the transaction was collected. Possible values are:

  • automatic
  • manual

created_at
DATE-TIME

The date and time the transaction was created.

currency
STRING

The three-letter ISO 4217 currency code.

customer_message
STRING

For declined transactions, the message displayed to the customer.

customer_message_locale
STRING

The language code used to display the customer_message.

cvv_check
STRING

When processed, the result from checking the CVV/CVC value on the transaction.

gateway_approval_code
STRING

The transaction approval code from the payment gateway.

gateway_message
STRING

The transaction message from the payment gateway.

gateway_reference
STRING

The transaction reference number from the payment gateway.

gateway_response_code
STRING

The gateway error code for declined transactions (success: false).

gateway_response_time
NUMBER

The time, in seconds, for the gateway to process the transaction.

gateway_response_values
OBJECT

The response values from the payment gateway.

id
STRING

The transaction ID.

Reference:

invoice
OBJECT

Details about the invoice associated with the transaction.

Click to expand invoice

id
STRING

The invoice ID.

Reference:

number
STRING

The invoice number.

object
STRING

This will be invoice.

state
STRING

The state of the invoice. Possible values are:

  • pending
  • processing
  • past_due
  • paid
  • failed

type
STRING

The type of the invoice. Possible values are:

  • charge
  • credit
  • legacy
invoices (table), invoice (attribute)

ip_address_country
STRING

The country, based on ip_address_v4.

ip_address_v4
STRING

The IP address provided when the billing information was collected:

  • When a customer entered billing info into Recurly.JS or a hosted payment page.
  • When the merchant enters billing info using the API.

object
STRING

origin
STRING

The origin of the transaction. Possible values are:

  • api
  • hpp
  • merchant
  • recurly_admin
  • recurlyjs
  • recurring
  • transparent
  • force_collect
  • refunded_externally
  • chargeback

original_transaction_id
STRING

If the transaction is a refund, this will be the ID of the original transaction.

Reference:

payment_gateway
OBJECT

Details about the payment gateway used to process the transaction.

Click to expand payment_gateway

id
STRING

name
STRING

object
STRING

type
STRING

invoices (table), payment_gateway (attribute)

payment_method
OBJECT

The payment method used in the transaction.

Click to expand payment_method

card_type
STRING

If the payment method is a credit card, this field will contain the type of the credit card. Possible values include:

  • American Express
  • Dankort
  • Diners Club
  • Discover
  • Forbrugsforeningen
  • JCB
  • Laser
  • Maestro
  • MasterCard
  • Test Card
  • Unknown
  • Visa

exp_month
INTEGER

If the payment method is a credit card, this field will contain the expiration month for the credit card.

exp_year
INTEGER

If the payment method is a credit card, this field will contain the expiration year for the credit card.

first_six
STRING

If the payment method is a credit card, this field will contain the first six digits of the credit card number.

last_four
STRING

If the payment method is a credit card, this field will contain the last four digits of the credit card number.

object
STRING

invoices (table), payment_method (attribute)

refunded
BOOLEAN

Indicates if part or all of the transaction was refunded.

status
STRING

The current transaction status. Possible values are:

  • pending
  • scheduled
  • processing
  • success
  • void
  • declined
  • error
  • chargeback

status_code
STRING

status_message
STRING

For declined transactions (success: false), the message displayed to the merchant.

subscription_ids
ARRAY

If the transaction refunds one or more subscriptions, this will be a list of the subscription IDs that were refunded.

Click to expand subscription_ids

value
STRING

The subscription ID.

Reference:

invoices (table), subscription_ids (attribute)

success
BOOLEAN

Indicates if the transaction completed successfully.

type
STRING

The type of the transaction. Possible values include:

  • authorization – Verifies billing information and places a hold on money in the customer’s account.
  • capture – Captures funds held by an authorization and completes a purchase.
  • purchase – Combines the authorization and capture in one transaction.
  • refund – Returns all or a portion of the money collected in a previous transaction to the customer.
  • verify – A $0 or $1 transaction used to verify billing information which is immediately voided.

uuid
STRING

The UUID is useful for matching data with the CSV exports and building URLs into Recurly’s UI.

voided_at
DATE-TIME

The date and time the transaction was voided.

voided_by_invoice
OBJECT

Details about the invoice that voided the transaction.

Click to expand voided_by_invoice

id
STRING

The invoice ID.

Reference:

number
STRING

The invoice number.

object
STRING

This will be invoice.

state
STRING

The state of the invoice. Possible values are:

  • pending
  • processing
  • past_due
  • paid
  • failed

type
STRING

The type of the invoice. Possible values are:

  • charge
  • credit
  • legacy
invoices (table), voided_by_invoice (attribute)
invoices (table), refund_transaction (attribute)

updated_at
DATE-TIME

The date and time 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
DATE-TIME

The date and time the credit payment was voided.
invoices (table), credit_payments (attribute)

currency
STRING

The three-letter ISO 4217 currency code.

customer_notes
STRING

The customer notes text specified in Invoice Settings.

discount
NUMBER

The total amount of discounts applied on the invoice.

due_at
DATE-TIME

The date and time the invoice is due.

line_items
OBJECT

Details about the line items in the invoice.

Click to expand line_items

data
ARRAY

Details about the line items in the invoice.

Click to expand data

accounting_code
STRING

The internal accounting code for the line item.

account
OBJECT

Details about the account associated with the line item.

Click to expand account

bill_to
STRING

Indicates whether charges on the account are billed using the parent’s billing info or the account itself. Possible values are:

  • self - The account itself.
  • parent - All invoices resulting in charges and credits originating from a child will be created on the parent account.

code
STRING

The unique identifier for the account.

company
STRING

The company.

email
STRING

The email.

first_name
STRING

The first name of the account.

id
STRING

The account ID.

Reference:

last_name
STRING

The last name of the account.

object
STRING

This will be account.

parent_account_id
STRING

If this is a child account, this field will contain the ID of the parent account.

Reference:

invoices (table), account (attribute)

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.

Reference:

amount
NUMBER

The total amount of the line item, calculated as (quantity * unit_amount) - (discount + tax).

created_at
DATE-TIME

The date and time the line item was created.

credit_applied
NUMBER

The amount of credit from this line item that was applied to the invoice.

credit_reason_code
STRING

When type: credit, this will be the reason the credit was given. Possible values include:

  • general
  • service
  • promotional
  • refund
  • gift_card
  • write_off

currency
STRING

The three-letter ISO 4217 currency code.

description
STRING

The description of the line item.

discount
NUMBER

The discount applied to the line item.

end_date
DATE-TIME

If this date is provided, it indicates the end of a time range.

id
STRING

The line item ID.

invoice_id
STRING

Once the line item has been invoiced this will be the invoice’s ID.

Reference:

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.

legacy_category
STRING

The category to describe the role of a line item on a legacy invoice. Possible values include:

  • 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

The origin of the invoice to return. Possible values are:

  • plan
  • plan_trial
  • setup_fee
  • add_on
  • add_on_trial
  • one_time
  • debit
  • credit
  • coupon
  • carryforward

original_line_item_invoice_id
STRING

The invoice where the credit originated. This field 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.

Reference:

previous_line_item_id
STRING

This field 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.

proration_rate
NUMBER

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
INTEGER

This number will be multiplied by the unit amount to compute the subtotal before any discounts or taxes.

refund
BOOLEAN

Indicates if the line item has been refunded.

refunded_quantity
INTEGER

For refund charges, the quantity being refunded. For non-refund charges, the total quantity refunded (possibly over multiple refunds).

shipping_addresses
ARRAY

The shipping address info for the line item.

Click to expand shipping_addresses

account_id
STRING

The ID of the account associated with the shipping address info.

Reference:

city
STRING

The shipping city.

company
STRING

The shipping company.

country
STRING

The two-letter ISO country code.

created_at
DATE-TIME

The timestamp when the shipping address was created.

email
STRING

The email associated with the shipping address.

first_name
STRING

The first name.

id
STRING

The shipping address ID.

last_name
STRING

The last name.

nickname
STRING

The nickname.

phone
STRING

The phone number.

postal_code
STRING

The postal code.

region
STRING

The state or province.

street1
STRING

The first street line of the address.

street2
STRING

The second street line of the address.

updated_at
DATE-TIME

The timestamp when the shipping address was last updated.

vat_number
STRING

The VAT number associated with the shipping address.
invoices (table), shipping_addresses (attribute)

start_date
DATE-TIME

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

The state of the line item. Possible values are:

  • pending - Pending line items are charges or credits on an account that have not been applied to an invoice yet.
  • invoiced - Invoiced line items will always have an invoice_id value.

subscription_id
STRING

The subscription ID associated with the line item.

Reference:

subtotal
NUMBER

The subtotal for the line item, calculated as quantity * unit_amount.

tax
NUMBER

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:

  • P0000000 - Indicates physical
  • D0000000 - Indicates digital
  • Empty string - Indicates unknown

tax_exempt
BOOLEAN

Indicates if the line item is tax exempt.

tax_info
OBJECT

Details about the tax applied to the line item.

Click to expand tax_info

rate
NUMBER

The tax rate.

region
STRING

Provides the tax region applied on an invoice. For U.S. Sales Tax, this will be the two-letter state code. For EU VAT this will be the two-letter country code. For all country level tax types, this will display the regional tax, like VAT, GST, or PST.

type
STRING

Provides the tax type as vat for EU VAT, usst for U.S. Sales Tax, or the two-letter country code for country level tax types like Canada, Australia, New Zealand, Israel, and all non-EU European countries.
invoices (table), tax_info (attribute)

taxable
BOOLEAN

Indicates if the line item is taxable.

type
STRING

The type of the line item. Possible values include:

  • charge - A positive line item that debits the account.
  • credit - A negative line item that credits the account.

unit_amount
NUMBER

The unit amount. This value will be positive for a charge and negative for a credit.

updated_at
DATE-TIME

The date and time the line item was last updated.

uuid
STRING

The UUID is useful for matching data with the CSV exports and building URLs into Recurly’s UI.
invoices (table), data (attribute)

has_more
BOOLEAN

next
STRING

object
STRING

invoices (table), line_items (attribute)

net_terms
NUMBER

An integer representing the number of days after an invoice’s creation that the invoice will become past due. If set to 0, the invoice is due on receipt and will become due 24 hours after its creation. If set to 30, it will become past due at exactly 31 days.

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

This will be invoice.

origin
STRING

The event that created the invoice. Possible values are:

  • purchase
  • line_item_refund
  • open_amount_refund
  • renewal
  • immediate_change
  • termination
  • credit
  • gift_card
  • write_off

paid
NUMBER

po_number
STRING

For manual invoicing, the PO number associated with the subscription.

previous_invoice_id
STRING

refundable_amount
NUMBER

state
STRING

The state of the invoice. Possible values are:

  • pending
  • processing
  • past_due
  • paid
  • failed

subscription_ids
ARRAY

If the invoice is charging or refunding one or more subscriptions, this will be a list of the associated subscription IDs.

Click to expand subscription_ids

value
STRING

The subscription ID.

Reference:

invoices (table), subscription_ids (attribute)

subtotal
NUMBER

The summation of charges, discounts, and credits, before tax.

tax
NUMBER

The total tax on the invoice.

tax_info
OBJECT

Details about the tax applied to the invoice.

Click to expand tax_info

rate
NUMBER

The tax rate.

region
STRING

Provides the tax region applied on an invoice. For U.S. Sales Tax, this will be the two-letter state code. For EU VAT this will be the two-letter country code. For all country level tax types, this will display the regional tax, like VAT, GST, or PST.

type
STRING

Provides the tax type as vat for EU VAT, usst for U.S. Sales Tax, or the two-letter country code for country level tax types like Canada, Australia, New Zealand, Israel, and all non-EU European countries.
invoices (table), tax_info (attribute)

terms_and_conditions
STRING

This will default to the Terms and Conditions text specified on the Invoice Settings page in your Recurly admin. This specifies custom notes to add or override Terms and Conditions.

total
NUMBER

The final total on this invoice. The summation of invoice charges, discounts, credits, and tax.

transactions
ARRAY

Details about the transactions associated with the invoice.

Click to expand transactions

amount
NUMBER

avs_check
STRING

account
OBJECT

Details about the account associated with the transaction.

Click to expand account

bill_to
STRING

Indicates whether charges on the account are billed using the parent’s billing info or the account itself. Possible values are:

  • self - The account itself.
  • parent - All invoices resulting in charges and credits originating from a child will be created on the parent account.

code
STRING

The unique identifier for the account.

company
STRING

The company.

email
STRING

The email.

first_name
STRING

The first name of the account.

id
STRING

The account ID.

Reference:

last_name
STRING

The last name of the account.

object
STRING

This will be account.

parent_account_id
STRING

If this is a child account, this field will contain the ID of the parent account.

Reference:

invoices (table), account (attribute)

billing_address
OBJECT

The billing address associated with the transaction.

Click to expand billing_address

city
STRING

The city.

country
STRING

The country.

first_name
STRING

The first name on the address.

last_name
STRING

The last name on the address.

name_on_account
STRING

The name on the account.

phone
STRING

The phone number.

postal_code
STRING

The postal code.

region
STRING

The region.

street1
STRING

The first street line.

street2
STRING

The second street line.
invoices (table), billing_address (attribute)

collected_at
DATE-TIME

collection_method
STRING

created_at
DATE-TIME

currency
STRING

The three-letter ISO 4217 currency code.

customer_message
STRING

For declined transactions, the message displayed to the customer.

customer_message_locale
STRING

The language code used to display the customer_message.

cvv_check
STRING

When processed, the result from checking the CVV/CVC value on the transaction.

gateway_approval_code
STRING

The transaction approval code from the payment gateway.

gateway_message
STRING

The transaction message from the payment gateway.

gateway_reference
STRING

The transaction reference number from the payment gateway.

gateway_response_code
STRING

The gateway error code for declined transactions (success: false).

gateway_response_time
NUMBER

The time, in seconds, for the gateway to process the transaction.

gateway_response_values
OBJECT

The response values from the payment gateway.

id
STRING

The transaction ID.

Reference:

invoice
OBJECT

Details about the invoice associated with the transaction.

Click to expand invoice

id
STRING

The invoice ID.

Reference:

number
STRING

The invoice number.

object
STRING

This will be invoice.

state
STRING

The state of the invoice. Possible values are:

  • pending
  • processing
  • past_due
  • paid
  • failed

type
STRING

The type of the invoice. Possible values are:

  • charge
  • credit
  • legacy
invoices (table), invoice (attribute)

ip_address_country
STRING

The country, based on ip_address_v4.

ip_address_v4
STRING

The IP address provided when the billing information was collected:

  • When a customer entered billing info into Recurly.JS or a hosted payment page.
  • When the merchant enters billing info using the API.

object
STRING

origin
STRING

The origin of the transaction. Possible values are:

  • api
  • hpp
  • merchant
  • recurly_admin
  • recurlyjs
  • recurring
  • transparent
  • force_collect
  • refunded_externally
  • chargeback

original_transaction_id
STRING

If the transaction is a refund, this will be the ID of the original transaction.

payment_gateway
OBJECT

Details about the payment gateway used to process the transaction.

Click to expand payment_gateway

id
STRING

name
STRING

object
STRING

type
STRING

invoices (table), payment_gateway (attribute)

payment_method
OBJECT

The payment method used in the transaction.

Click to expand payment_method

card_type
STRING

If the payment method is a credit card, this field will contain the type of the credit card. Possible values include:

  • American Express
  • Dankort
  • Diners Club
  • Discover
  • Forbrugsforeningen
  • JCB
  • Laser
  • Maestro
  • MasterCard
  • Test Card
  • Unknown
  • Visa

exp_month
INTEGER

If the payment method is a credit card, this field will contain the expiration month for the credit card.

exp_year
INTEGER

If the payment method is a credit card, this field will contain the expiration year for the credit card.

first_six
STRING

If the payment method is a credit card, this field will contain the first six digits of the credit card number.

last_four
STRING

If the payment method is a credit card, this field will contain the last four digits of the credit card number.

object
STRING

invoices (table), payment_method (attribute)

refunded
BOOLEAN

Indicates if part or all of the transaction was refunded.

status
STRING

The current transaction status. Possible values are:

  • pending
  • scheduled
  • processing
  • success
  • void
  • declined
  • error
  • chargeback

status_code
STRING

status_message
STRING

subscription_ids
ARRAY

If the transaction refunds one or more subscriptions, this will be a list of the subscription IDs that were refunded.

Click to expand subscription_ids

value
STRING

The subscription ID.

Reference:

invoices (table), subscription_ids (attribute)

success
BOOLEAN

Indicates if the transaction completed successfully.

type
STRING

The type of the transaction. Possible values include:

  • authorization – Verifies billing information and places a hold on money in the customer’s account.
  • capture – Captures funds held by an authorization and completes a purchase.
  • purchase – Combines the authorization and capture in one transaction.
  • refund – Returns all or a portion of the money collected in a previous transaction to the customer.
  • verify – A $0 or $1 transaction used to verify billing information which is immediately voided.

uuid
STRING

The UUID is useful for matching data with the CSV exports and building URLs into Recurly’s UI.

voided_at
DATE-TIME

The date and time the transaction was voided.

voided_by_invoice
OBJECT

Details about the invoice that voided the transaction.

Click to expand voided_by_invoice

id
STRING

The invoice ID.

Reference:

number
STRING

The invoice number.

object
STRING

This will be invoice.

state
STRING

The state of the invoice. Possible values are:

  • pending
  • processing
  • past_due
  • paid
  • failed

type
STRING

The type of the invoice. Possible values are:

  • charge
  • credit
  • legacy
invoices (table), voided_by_invoice (attribute)
invoices (table), transactions (attribute)

type
STRING

The type of the invoice. Possible values are:

  • charge
  • credit
  • legacy

vat_number
STRING

The 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.

plans

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

id

 API endpoint :

List a site’s plans

The plans table contains info about the plans in your Recurly account. A plan tells Recurly how much to charge customers.

plans table schema

id
STRING

The plan ID.

Reference:

updated_at
DATE-TIME

The date and time the plan was last updated.

accounting_code
STRING

Accounting code for invoice line items for the plan.

auto_renew
BOOLEAN

Subscriptions will automatically inherit this value once they are active. If auto_renew: true, then a subscription will automatically renew its term at renewal. If auto_renew: false, then a subscription will expire at the end of its term.

code
STRING

The unique code to identify the plan. This is used in Hosted Payment Page URLs and in the invoice exports.

created_at
DATE-TIME

The date and time the plan was created.

currencies
ARRAY

Details about the currencies associated with the plan.

Click to expand currencies

currency
STRING

The three-letter ISO 4217 currency code.

setup_fee
NUMBER

Amount of one-time setup fee automatically charged at the beginning of a subscription billing cycle. For subscription plans with a trial, the setup fee will be charged at the time of signup. Setup fees do not increase with the quantity of a subscription plan.

unit_amount
NUMBER

plans (table), currencies (attribute)

deleted_at
DATE-TIME

The date and time the plan was deleted.

description
STRING

The description of the plan.

hosted_pages
OBJECT

The hosted pages associated with the plan.

Click to expand hosted_pages

bypass_confirmation
BOOLEAN

If true, the customer will be sent directly to the success_url after a successful signup, bypassing Recurly’s hosted confirmation page.

cancel_url
STRING

The URL to redirect to on canceled signup on the hosted payment pages.

display_quantity
BOOLEAN

Indicates if the quantity field is displayed on hosted pages for the plan.

success_url
STRING

The URL to redirect to after signup on the hosted payment pages.
plans (table), hosted_pages (attribute)

interval_length
INTEGER

The length of the plan’s billing interval in interval_unit. For example: A value of 30 with an interval_unit of days means the plan’s billing interval is 30 days.

interval_unit
STRING

The unit for the plan’s billing interval. Possible values are:

  • days
  • months

name
STRING

This name describes the plan and will appear on the Hosted Payment Page and the subscriber’s invoice.

object
STRING

setup_fee_accounting_code
STRING

Accounting code for invoice line items for the plan’s setup fee.

state
STRING

The current state of the plan. Possible values are:

  • active
  • 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:

  • P0000000 - Physical
  • D0000000 - Digital
  • Empty string - Unknown

tax_exempt
BOOLEAN

Indicates whether the plan is tax exempt.

total_billing_cycles
INTEGER

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.

trial_length
INTEGER

The length of the plan’s trial period in trial_unit. A value of 0 means no trial.

trial_unit
STRING

The unit for the plan’s trial period. Possible values are:

  • days
  • months

plans_add_ons

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

id

 API endpoint :

List a plan’s add-ons

The plans_add_ons table contains info about the add-ons in your Recurly account. An add-on is a charge billed each billing period in addition to a subscription’s base charge.

Note: To replicate this table, you must also have the plans table set to replicate.

plans_add_ons table schema

id
STRING

The plan add-on ID.

Reference:

updated_at
DATE-TIME

The date and time the add-on was last updated.

accounting_code
STRING

The accounting code for invoice line items for this add-on.

code
STRING

The unique identifier for the add-on within its plan.

created_at
DATE-TIME

The date and time the add-on was created.

currencies
ARRAY

The currencies associated with the add-on.

Click to expand currencies

currency
STRING

The three-letter ISO 4217 currency code.

unit_amount
NUMBER

The unit price.
plans_add_ons (table), currencies (attribute)

default_quantity
INTEGER

The default quantity for the hosted pages.

deleted_at
DATE-TIME

The date and time the add-on was deleted.

display_quantity
BOOLEAN

Determines if the quantity field is displayed on the hosted pages for the add-on.

name
STRING

The add-on name.

object
STRING

plan_id
STRING

The ID of the plan the add-on is associated with.

Reference:

state
STRING

The state of the add-on. Possible values are:

  • active
  • 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:

  • P0000000 - Physical
  • D0000000 - Digital
  • Empty string - Unknown

subscriptions

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

id

 API endpoint :

List a site’s subscriptions

The subscriptions table contains info about the subscriptions in your Recurly account. Subscriptions are created when your customers subscribe to one of your plans. The customer’s subscription tells Recurly when and how much to bill the customer.

Custom fields

Stitch’s Recurly integration supports replicating custom fields for subscription objects.

subscriptions table schema

id
STRING

The subscription ID.

Reference:

updated_at
DATE-TIME

The date and time the subscription was last updated.

account
OBJECT

Details about the account associated with the subscription.

Click to expand account

bill_to
STRING

Indicates whether charges on the account are billed using the parent’s billing info or the account itself. Possible values are:

  • self - The account itself.
  • parent - All invoices resulting in charges and credits originating from a child will be created on the parent account.

code
STRING

The unique identifier for the account.

company
STRING

The company.

email
STRING

The email.

first_name
STRING

The first name of the account.

id
STRING

The account ID.

Reference:

last_name
STRING

The last name of the account.

object
STRING

This will be account.

parent_account_id
STRING

If this is a child account, this field will contain the ID of the parent account.

Reference:

subscriptions (table), account (attribute)

activated_at
DATE-TIME

The date and time the subscription was activated.

add_ons
ARRAY

Details about the add-ons associated with the subscription.

Click to expand add_ons

add_on
OBJECT

Details about the add-on.

Click to expand add_on

accounting_code
STRING

The accounting code for invoice line items for this add-on.

code
STRING

The unique identifier for the add-on within its plan.

id
STRING

The add-on ID.

Reference:

name
STRING

The name of the add-on.

object
STRING

subscriptions (table), add_on (attribute)

created_at
DATE-TIME

The date and time the add-on was added to the subscription.

expired_at
DATE-TIME

The date and time the add-on will expire.

id
STRING

The subscription add-on ID.

object
STRING

quantity
NUMBER

The quantity of the add-on.

subscription_id
STRING

The ID of the subscription associated with the add-on.

Reference:

unit_amount
NUMBER

The unit amount of the add-on in the subscription’s currency.

updated_at
DATE-TIME

The date and time the subscription add-on was last updated.
subscriptions (table), add_ons (attribute)

add_ons_total
NUMBER

The total price of the add-ons associated with the subscription.

auto_renew
BOOLEAN

Indicates whether the subscription renews at the end of its term.

bank_account_authorized_at
DATE-TIME

canceled_at
DATE-TIME

collection_method
STRING

The collection method for the subscription. Possible values are:

  • automatic
  • manual

coupon_redemptions
ARRAY

Details about the coupon redemptions associated with the subscription.

Click to expand coupon_redemptions

coupon
OBJECT

Click to expand coupon

code
STRING

The code the customer enters to redeem the coupon.

coupon_type
STRING

The type of the coupon. Possible values are:

  • single_code
  • bulk

discount
OBJECT

Details of the discount a coupon applies.

Click to expand discount

currencies
ARRAY

Applicable only when type: fixed. The currencies associated with the coupon discount.

Click to expand currencies

amount
NUMBER

The value of the fixed discount that the coupon applies.

currency
STRING

The three-letter ISO 4217 currency code.
subscriptions (table), currencies (attribute)

percent
INTEGER

Applicable only when type: percent. The percent of the total that is used to calculate the discount.

trial
OBJECT

Applicable only when type: free_trial. Details about the discount for free trials.

Click to expand trial

length
NUMBER

The trial length measured in units, specified by unit.

unit
STRING

The temporal unit of the free trial. Possible values are:

  • day
  • week
  • month
subscriptions (table), trial (attribute)

type
STRING

The type of discount the coupon applies. Possible values are:

  • percent
  • fixed
  • free_trial
subscriptions (table), discount (attribute)

expired_at
DATE-TIME

The date and time the coupon was expired early or reached its max_redemptions.

id
STRING

The coupon ID.

Reference:

name
STRING

The internal name for the coupon.

object
STRING

state
STRING

The coupon’s redemption status. Possible values are:

  • redeemable
  • maxed_out
  • expired
subscriptions (table), coupon (attribute)

created_at
DATE-TIME

The date and time the coupon redemption was created.

discounted
STRING

The amount that was discounted upon the application of the coupon, formatted with the currency.

id
STRING

The coupon redemption ID.

Reference:

object
STRING

state
STRING

The state of the redemption. Possible values are:

  • active
  • inactive
subscriptions (table), coupon_redemptions (attribute)

created_at
DATE-TIME

The date and time the subscription was created.

currency
STRING

The three-letter ISO 4217 currency code associated with the subscription.

current_period_ends_at
DATE-TIME

The date the current billing period for the subscription ends.

current_period_started_at
DATE-TIME

The date the current billing period for the subscription started.

current_term_ends_at
DATE-TIME

The end date when the first billing period ends. This is calculated by a plan’s interval and total_billing_cycles in a term. Subscription changes with a timeframe: renewal will be applied on this date.

current_term_started_at
DATE-TIME

The start date of the term when the first billing period starts. The subscription term is the length of time that a customer will be committed to a subscription. A term can span multiple billing periods.

custom_fields
ARRAY

A list of custom fields associated with the subscription.

Click to expand custom_fields

name
STRING

The name of the custom field.

value
STRING

The value of the custom field.
subscriptions (table), custom_fields (attribute)

customer_notes
STRING

Customer notes associated with the subscription.

expiration_reason
STRING

The expiration reason associated with the subscription.

expires_at
DATE-TIME

The date and time the subscription expired.

net_terms
INTEGER

An 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.

object
STRING

paused_at
DATE-TIME

The date and time the subscription was paused. This value will be null unless the subscription is paused or will pause at the end of the current billing period.

pending_change
OBJECT

Details about any pending changes associated with the subscription.

Click to expand pending_change

activate_at
DATE-TIME

The date and time the subscription change was activated.

activated
BOOLEAN

Indicates if the subscription is active.

add_ons
ARRAY

Details about the add-ons that will be used when the subscription renews.

Click to expand add_ons

add_on
OBJECT

Details about the add-on associated with the subscription change.

Click to expand add_on

accounting_code
STRING

The accounting code for invoice line items for this add-on.

code
STRING

The unique identifier for the add-on within its plan.

id
STRING

The add-on ID.

Reference:

name
STRING

The name of the add-on.

object
STRING

subscriptions (table), add_on (attribute)

created_at
DATE-TIME

The date and time the add-on associated with the subscription change was created.

expired_at
DATE-TIME

The date and time the add-on associated with the subscription change will expire.

id
STRING

The subscription add-on ID.

object
STRING

quantity
NUMBER

The subscription add-on quantity.

subscription_id
STRING

The subscription ID.

Reference:

unit_amount
NUMBER

updated_at
DATE-TIME

The date and time the add-on associated with the subscription change was last updated.
subscriptions (table), add_ons (attribute)

created_at
DATE-TIME

The date and time the subscription change was created.

deleted_at
DATE-TIME

The date and time the subscription change was deleted.

id
STRING

The subscription change ID.

object
STRING

plan
OBJECT

Details about the plan associated with the pending change.

Click to expand plan

code
STRING

The unique code to identify the plan. This is used in Hosted Payment Page URLs and in the invoice exports.

id
STRING

The plan ID.

Reference:

name
STRING

The name of the plan.

object
STRING

subscriptions (table), plan (attribute)

quantity
NUMBER

The subscription quantity.

subscription_id
STRING

The ID of the subscription that is going to be changed.

Reference:

unit_amount
NUMBER

updated_at
DATE-TIME

The date and time the subscription change was last updated.
subscriptions (table), pending_change (attribute)

plan
OBJECT

Details about the plan associated with the subscription.

Click to expand plan

code
STRING

The unique code to identify the plan. This is used in Hosted Payment Page URLs and in the invoice exports.

id
STRING

The plan ID.

Reference:

name
STRING

The name of the plan.

object
STRING

subscriptions (table), plan (attribute)

po_number
STRING

For manual invoicing, this identifies the PO number associated with the subscription.

quantity
INTEGER

remaining_billing_cycles
INTEGER

The remaining billing cycles in the current term.

remaining_pause_cycles
INTEGER

This value will be null unless the subscription is paused or will pause at the end of the current billing period.

renewal_billing_cycles
INTEGER

If auto_renew: true, when a term completes, total_billing_cycles takes this value as the length of subsequent terms.

shipping_addresses
ARRAY

The shipping address info for the subscription.

Click to expand shipping_addresses

account_id
STRING

The ID of the account associated with the shipping address info.

Reference:

city
STRING

The shipping city.

company
STRING

The shipping company.

country
STRING

The two-letter ISO country code.

created_at
DATE-TIME

The timestamp when the shipping address was created.

email
STRING

The email associated with the shipping address.

first_name
STRING

The first name.

id
STRING

The shipping address ID.

last_name
STRING

The last name.

nickname
STRING

The nickname.

phone
STRING

The phone number.

postal_code
STRING

The postal code.

region
STRING

The state or province.

street1
STRING

The first street line of the address.

street2
STRING

The second street line of the address.

updated_at
DATE-TIME

The timestamp when the shipping address was last updated.

vat_number
STRING

The VAT number associated with the shipping address.
subscriptions (table), shipping_addresses (attribute)

state
STRING

The state of the subscription. Possible values are:

  • active
  • canceled
  • expired
  • failed
  • future
  • paused

subtotal
NUMBER

The subscription subtotal, before taxes.

terms_and_conditions
STRING

The terms and conditions for the subscription.

total_billing_cycles
NUMBER

The number of cycles/billing periods in a term. When remaining_billing_cycles: 0, if auto_renew: true the subscription will renew and a new term will begin, otherwise the subscription will expire.

trial_ends_at
DATE-TIME

The date the trial for the subscription ended.

trial_started_at
DATE-TIME

The date the trial for the subscription started.

unit_amount
NUMBER

uuid
STRING

The UUID is useful for matching data with the CSV exports and building URLs into Recurly’s UI.

transactions

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

collected_at
Primary Key :

id

 API endpoint :

List a site’s transactions

The transactions table contains info about the transactions in your Recurly account.

transactions table schema

id
STRING

The transaction ID.

Reference:

collected_at
DATE-TIME

If collected, the date and time the transaction was collected. Otherwise, the time the transaction was created.

account
OBJECT

Details about the account associated with the subscription.

Click to expand account

bill_to
STRING

Indicates whether charges on the account are billed using the parent’s billing info or the account itself. Possible values are:

  • self - The account itself.
  • parent - All invoices resulting in charges and credits originating from a child will be created on the parent account.

code
STRING

The unique identifier for the account.

company
STRING

The company.

email
STRING

The email.

first_name
STRING

The first name of the account.

id
STRING

The account ID.

Reference:

last_name
STRING

The last name of the account.

object
STRING

This will be account.

parent_account_id
STRING

If this is a child account, this field will contain the ID of the parent account.

Reference:

transactions (table), account (attribute)

amount
NUMBER

The amount of the transaction.

avs_check
STRING

The result from checking the overall AVS on the processed transaction.

billing_address
OBJECT

The billing address for the transaction.

Click to expand billing_address

city
STRING

The city.

country
STRING

The country.

first_name
STRING

The first name on the address.

last_name
STRING

The last name on the address.

name_on_account
STRING

The name on the account.

phone
STRING

The phone number.

postal_code
STRING

The postal code.

region
STRING

The region.

street1
STRING

The first street line.

street2
STRING

The second street line.
transactions (table), billing_address (attribute)

collection_method
STRING

The method by which payment for the transaction was collected. Possible values are:

  • automatic
  • manual

created_at
DATE-TIME

The date and time the transaction was created.

currency
STRING

The three-letter 4217 ISO currency code.

customer_message
STRING

For declined transactions, the message displayed to the customer.

customer_message_locale
STRING

The language code used to display the customer_message.

cvv_check
STRING

When processed, the result from checking the CVV/CVC value on the transaction.

gateway_approval_code
STRING

The transaction approval code from the payment gateway.

gateway_message
STRING

The transaction message from the payment gateway.

gateway_reference
STRING

The transaction reference number from the payment gateway.

gateway_response_code
STRING

The gateway error code for declined transactions (success: false).

gateway_response_time
NUMBER

The time, in seconds, for the gateway to process the transaction.

gateway_response_values
OBJECT

The response values from the payment gateway.

invoice
OBJECT

Details about the invoice associated with the transaction.

Click to expand invoice

id
STRING

The invoice ID.

Reference:

number
STRING

The invoice number.

object
STRING

This will be invoice.

state
STRING

The state of the invoice. Possible values are:

  • pending
  • processing
  • past_due
  • paid
  • failed

type
STRING

The type of the invoice. Possible values are:

  • charge
  • credit
  • legacy
transactions (table), invoice (attribute)

ip_address_country
STRING

The country, based on ip_address_v4.

ip_address_v4
STRING

The IP address provided when the billing information was collected:

  • When a customer entered billing info into Recurly.JS or a hosted payment page.
  • When the merchant enters billing info using the API.

object
STRING

origin
STRING

The origin of the transaction. Possible values are:

  • api
  • hpp
  • merchant
  • recurly_admin
  • recurlyjs
  • recurring
  • transparent
  • force_collect
  • refunded_externally
  • chargeback

original_transaction_id
STRING

If the transaction is a refund (type: refund), this will be the ID of the original transaction on the invoice being refunded.

Reference:

payment_gateway
OBJECT

Details about the payment gateway used to process the transaction.

Click to expand payment_gateway

id
STRING

name
STRING

object
STRING

type
STRING

transactions (table), payment_gateway (attribute)

payment_method
OBJECT

The payment method used in the transaction.

Click to expand payment_method

card_type
STRING

If the payment method is a credit card, this field will contain the type of the credit card. Possible values include:

  • American Express
  • Dankort
  • Diners Club
  • Discover
  • Forbrugsforeningen
  • JCB
  • Laser
  • Maestro
  • MasterCard
  • Test Card
  • Unknown
  • Visa

exp_month
INTEGER

If the payment method is a credit card, this field will contain the expiration month for the credit card.

exp_year
INTEGER

If the payment method is a credit card, this field will contain the expiration year for the credit card.

first_six
STRING

If the payment method is a credit card, this field will contain the first six digits of the credit card number.

last_four
STRING

If the payment method is a credit card, this field will contain the last four digits of the credit card number.

object
STRING

transactions (table), payment_method (attribute)

refunded
BOOLEAN

Indicates if part or all of the transaction was refunded.

status
STRING

The current transaction status. Possible values are:

  • pending
  • scheduled
  • processing
  • success
  • void
  • declined
  • error
  • chargeback

status_code
STRING

status_message
STRING

For declined transactions (success: false), the message displayed to the merchant.

subscription_ids
ARRAY

If the transaction refunds one or more subscriptions, this will be a list of the subscription IDs that were refunded.

Click to expand subscription_ids

value
STRING

The subscription ID.

Reference:

transactions (table), subscription_ids (attribute)

success
BOOLEAN

Indicates if the transaction completed successfully.

type
STRING

The type of the transaction. Possible values include:

  • authorization – Verifies billing information and places a hold on money in the customer’s account.
  • capture – Captures funds held by an authorization and completes a purchase.
  • purchase – Combines the authorization and capture in one transaction.
  • refund – Returns all or a portion of the money collected in a previous transaction to the customer.
  • verify – A $0 or $1 transaction used to verify billing information which is immediately voided.

uuid
STRING

The UUID is useful for matching data with the CSV exports and building URLs into Recurly’s UI.

voided_at
DATE-TIME

The date and time the transaction was voided.

voided_by_invoice
OBJECT

Details about the invoice that voided the transaction.

Click to expand voided_by_invoice

id
STRING

The invoice ID.

Reference:

number
STRING

The invoice number.

object
STRING

This will be invoice.

state
STRING

The state of the invoice. Possible values are:

  • pending
  • processing
  • past_due
  • paid
  • failed

type
STRING

The type of the invoice. Possible values are:

  • charge
  • credit
  • legacy
transactions (table), voided_by_invoice (attribute)
Related Troubleshooting
Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.