Skip to main content

Recurly

Setting up the Recurly connector

NoItemRequiredExampleNotes
1API KeyYesRecurly API Key. See the docs for more information on how to generate this key.
2begin_timeNo2021-12-01T00:00:00ISO8601 timestamp from which the replication from Recurly API will start from.
3end_timeNo2021-12-01T00:00:00ISO8601 timestamp to which the replication from Recurly API will stop. Records after that date won't be imported.

Tables in the Recurly connector

NoTable NameColumnsPrimary KeysRead ModeInc. Sync KeysAPI Info
1export_dates1Full Refresh
2subscriptions43idFull Refresh, Incrementalupdated_atAPI Reference
3credit_payments13idFull Refresh, Incrementalupdated_at
4account_coupon_redemptions10idFull Refresh, Incrementalupdated_at
5billing_infos14idFull Refresh, Incrementalupdated_at
6measured_units8idFull Refresh, Incrementalupdated_at
7line_items44idFull Refresh, Incrementalupdated_at
8shipping_addresses17idFull Refresh, Incrementalupdated_at
9transactions37idFull Refresh, Incrementalupdated_atAPI Reference
10unique_coupons9idFull Refresh, Incrementalupdated_at
11invoices35idFull Refresh, Incrementalupdated_atAPI Reference
12shipping_methods8idFull Refresh, Incrementalupdated_at
13account_notes5idFull Refresh, Incrementalcreated_at
14coupons27idFull Refresh, Incrementalupdated_atAPI Reference
15plans27idFull Refresh, Incrementalupdated_atAPI Reference
16add_ons22idFull Refresh, Incrementalupdated_at
17accounts27idFull Refresh, Incrementalupdated_atAPI Reference

Table: export_dates

NoColumn NameTypeNotes
1datesVARCHAR

Table: subscriptions

NoColumn NameTypeNotes
1canceled_atVARCHAR
2created_atVARCHAR
3current_period_ends_atVARCHAR
4uuidVARCHAR
5renewal_billing_cyclesDOUBLE
6current_period_started_atVARCHAR
7totalDOUBLE
8po_numberVARCHAR
9pending_changeVARCHAR
10current_term_started_atVARCHAR
11paused_atVARCHAR
12expires_atVARCHAR
13shippingVARCHAR
14updated_atVARCHARIncremental sync key
15bank_account_authorized_atVARCHAR
16add_onsVARCHAR
17currencyVARCHAR
18net_termsDOUBLE
19idVARCHARPrimary Key
20stateVARCHAR
21planVARCHAR
22billing_info_idVARCHAR
23total_billing_cyclesDOUBLE
24remaining_billing_cyclesDOUBLE
25quantityDOUBLE
26current_term_ends_atVARCHAR
27revenue_schedule_typeVARCHAR
28taxDOUBLE
29unit_amountDOUBLE
30customer_notesVARCHAR
31terms_and_conditionsVARCHAR
32activated_atVARCHAR
33expiration_reasonVARCHAR
34auto_renewBOOLEAN
35tax_infoVARCHAR
36add_ons_totalDOUBLE
37subtotalDOUBLE
38collection_methodVARCHAR
39trial_started_atVARCHAR
40trial_ends_atVARCHAR
41remaining_pause_cyclesDOUBLE
42gateway_codeVARCHAR
43accountVARCHAR

Table: credit_payments

NoColumn NameTypeNotes
1original_invoiceVARCHAR
2voided_atVARCHAR
3amountDOUBLE
4created_atVARCHAR
5uuidVARCHAR
6applied_to_invoiceVARCHAR
7updated_atVARCHARIncremental sync key
8actionVARCHAR
9currencyVARCHAR
10original_credit_payment_idVARCHAR
11idVARCHARPrimary Key
12accountVARCHAR
13refund_transactionVARCHAR

Table: account_coupon_redemptions

NoColumn NameTypeNotes
1subscription_idVARCHAR
2discountedDOUBLE
3removed_atVARCHAR
4couponVARCHAR
5updated_atVARCHARIncremental sync key
6created_atVARCHAR
7currencyVARCHAR
8idVARCHARPrimary Key
9stateVARCHAR
10accountVARCHAR

Table: billing_infos

NoColumn NameTypeNotes
1addressVARCHAR
2vat_numberVARCHAR
3last_nameVARCHAR
4created_atVARCHAR
5primary_payment_methodBOOLEAN
6validBOOLEAN
7account_idVARCHAR
8updated_atVARCHARIncremental sync key
9fraudVARCHAR
10backup_payment_methodBOOLEAN
11companyVARCHAR
12idVARCHARPrimary Key
13first_nameVARCHAR
14payment_methodVARCHAR

Table: measured_units

NoColumn NameTypeNotes
1updated_atVARCHARIncremental sync key
2nameVARCHAR
3descriptionVARCHAR
4created_atVARCHAR
5idVARCHARPrimary Key
6stateVARCHAR
7display_nameVARCHAR
8deleted_atVARCHAR

Table: line_items

NoColumn NameTypeNotes
1external_skuVARCHAR
2end_dateVARCHAR
3item_codeVARCHAR
4credit_appliedDOUBLE
5originVARCHAR
6plan_codeVARCHAR
7descriptionVARCHAR
8discountDOUBLE
9created_atVARCHAR
10typeVARCHAR
11product_codeVARCHAR
12uuidVARCHAR
13subscription_idVARCHAR
14updated_atVARCHARIncremental sync key
15refunded_quantityINTEGER
16invoice_idVARCHAR
17currencyVARCHAR
18idVARCHARPrimary Key
19stateVARCHAR
20shipping_addressVARCHAR
21legacy_categoryVARCHAR
22invoice_numberVARCHAR
23start_dateVARCHAR
24amountDOUBLE
25add_on_idVARCHAR
26previous_line_item_idVARCHAR
27quantityINTEGER
28taxableBOOLEAN
29item_idVARCHAR
30tax_exemptBOOLEAN
31proration_rateDOUBLE
32revenue_schedule_typeVARCHAR
33unit_amount_decimalVARCHAR
34taxDOUBLE
35unit_amountDOUBLE
36bill_for_account_idVARCHAR
37credit_reason_codeVARCHAR
38accounting_codeVARCHAR
39tax_codeVARCHAR
40subtotalDOUBLE
41add_on_codeVARCHAR
42original_line_item_invoice_idVARCHAR
43plan_idVARCHAR
44refundBOOLEAN

Table: shipping_addresses

NoColumn NameTypeNotes
1countryVARCHAR
2cityVARCHAR
3vat_numberVARCHAR
4last_nameVARCHAR
5created_atVARCHAR
6account_idVARCHAR
7updated_atVARCHARIncremental sync key
8phoneVARCHAR
9nicknameVARCHAR
10companyVARCHAR
11street1VARCHAR
12idVARCHARPrimary Key
13street2VARCHAR
14regionVARCHAR
15postal_codeVARCHAR
16first_nameVARCHAR
17emailVARCHAR

Table: transactions

NoColumn NameTypeNotes
1status_messageVARCHAR
2voided_atVARCHAR
3ip_address_v4VARCHAR
4avs_checkVARCHAR
5original_transaction_idVARCHAR
6status_codeVARCHAR
7ip_address_countryVARCHAR
8originVARCHAR
9gateway_approval_codeVARCHAR
10created_atVARCHAR
11billing_addressVARCHAR
12typeVARCHAR
13uuidVARCHAR
14customer_message_localeVARCHAR
15cvv_checkVARCHAR
16subscription_idsVARCHAR
17updated_atVARCHARIncremental sync key
18currencyVARCHAR
19refundedBOOLEAN
20idVARCHARPrimary Key
21payment_methodVARCHAR
22gateway_response_timeDOUBLE
23amountDOUBLE
24customer_messageVARCHAR
25payment_gatewayVARCHAR
26gateway_referenceVARCHAR
27backup_payment_method_usedBOOLEAN
28voided_by_invoiceVARCHAR
29collected_atVARCHAR
30gateway_messageVARCHAR
31successBOOLEAN
32gateway_response_codeVARCHAR
33collection_methodVARCHAR
34invoiceVARCHAR
35accountVARCHAR
36statusVARCHAR
37gateway_response_valuesVARCHAR

Table: unique_coupons

NoColumn NameTypeNotes
1redeemed_atVARCHAR
2codeVARCHAR
3bulk_coupon_idVARCHAR
4updated_atVARCHARIncremental sync key
5created_atVARCHAR
6idVARCHARPrimary Key
7stateVARCHAR
8expired_atVARCHAR
9bulk_coupon_codeVARCHAR

Table: invoices

NoColumn NameTypeNotes
1vat_numberVARCHAR
2originVARCHAR
3discountDOUBLE
4created_atVARCHAR
5line_itemsVARCHAR
6typeVARCHAR
7vat_reverse_charge_notesVARCHAR
8subscription_idsVARCHAR
9numberVARCHAR
10po_numberVARCHAR
11totalDOUBLE
12balanceDOUBLE
13updated_atVARCHARIncremental sync key
14dunning_campaign_idVARCHAR
15previous_invoice_idVARCHAR
16net_termsINTEGER
17currencyVARCHAR
18due_atVARCHAR
19idVARCHARPrimary Key
20stateVARCHAR
21shipping_addressVARCHAR
22billing_info_idVARCHAR
23addressVARCHAR
24closed_atVARCHAR
25credit_paymentsVARCHAR
26taxDOUBLE
27customer_notesVARCHAR
28transactionsVARCHAR
29terms_and_conditionsVARCHAR
30refundable_amountDOUBLE
31tax_infoVARCHAR
32subtotalDOUBLE
33collection_methodVARCHAR
34paidDOUBLE
35accountVARCHAR

Table: shipping_methods

NoColumn NameTypeNotes
1accounting_codeVARCHAR
2tax_codeVARCHAR
3codeVARCHAR
4updated_atVARCHARIncremental sync key
5nameVARCHAR
6created_atVARCHAR
7idVARCHARPrimary Key
8deleted_atVARCHAR

Table: account_notes

NoColumn NameTypeNotes
1account_idVARCHAR
2created_atVARCHARIncremental sync key
3idVARCHARPrimary Key
4messageVARCHAR
5userVARCHAR

Table: coupons

NoColumn NameTypeNotes
1redeem_byVARCHAR
2codeVARCHAR
3unique_coupon_codes_countDOUBLE
4discountVARCHAR
5created_atVARCHAR
6expired_atVARCHAR
7durationVARCHAR
8applies_to_non_plan_chargesBOOLEAN
9updated_atVARCHARIncremental sync key
10max_redemptions_per_accountDOUBLE
11invoice_descriptionVARCHAR
12idVARCHARPrimary Key
13stateVARCHAR
14applies_to_all_itemsBOOLEAN
15temporal_unitVARCHAR
16max_redemptionsDOUBLE
17free_trial_unitVARCHAR
18applies_to_all_plansBOOLEAN
19hosted_page_descriptionVARCHAR
20redemption_resourceVARCHAR
21free_trial_amountDOUBLE
22unique_code_templateVARCHAR
23temporal_amountDOUBLE
24plansVARCHAR
25nameVARCHAR
26itemsVARCHAR
27coupon_typeVARCHAR

Table: plans

NoColumn NameTypeNotes
1hosted_pagesVARCHAR
2codeVARCHAR
3setup_fee_accounting_codeVARCHAR
4allow_any_item_on_subscriptionsBOOLEAN
5descriptionVARCHAR
6created_atVARCHAR
7trial_lengthDOUBLE
8interval_unitVARCHAR
9dunning_campaign_idVARCHAR
10updated_atVARCHARIncremental sync key
11avalara_service_typeDOUBLE
12trial_unitVARCHAR
13trial_requires_billing_infoBOOLEAN
14idVARCHARPrimary Key
15stateVARCHAR
16total_billing_cyclesDOUBLE
17tax_exemptBOOLEAN
18revenue_schedule_typeVARCHAR
19setup_fee_revenue_schedule_typeVARCHAR
20avalara_transaction_typeDOUBLE
21deleted_atVARCHAR
22accounting_codeVARCHAR
23tax_codeVARCHAR
24auto_renewBOOLEAN
25nameVARCHAR
26interval_lengthDOUBLE
27currenciesVARCHAR

Table: add_ons

NoColumn NameTypeNotes
1add_on_typeVARCHAR
2codeVARCHAR
3display_quantityBOOLEAN
4usage_percentageDOUBLE
5revenue_schedule_typeVARCHAR
6created_atVARCHAR
7avalara_transaction_typeVARCHAR
8optionalBOOLEAN
9deleted_atVARCHAR
10accounting_codeVARCHAR
11tax_codeVARCHAR
12updated_atVARCHARIncremental sync key
13usage_typeVARCHAR
14avalara_service_typeVARCHAR
15measured_unit_idVARCHAR
16nameVARCHAR
17default_quantityINTEGER
18idVARCHARPrimary Key
19stateVARCHAR
20tier_typeVARCHAR
21plan_idVARCHAR
22currenciesVARCHAR

Table: accounts

NoColumn NameTypeNotes
1bill_toVARCHAR
2has_future_subscriptionBOOLEAN
3preferred_localeVARCHAR
4codeVARCHAR
5vat_numberVARCHAR
6created_atVARCHAR
7has_live_subscriptionBOOLEAN
8has_paused_subscriptionBOOLEAN
9cc_emailsVARCHAR
10dunning_campaign_idVARCHAR
11updated_atVARCHARIncremental sync key
12exemption_certificateVARCHAR
13companyVARCHAR
14idVARCHARPrimary Key
15stateVARCHAR
16first_nameVARCHAR
17emailVARCHAR
18addressVARCHAR
19tax_exemptBOOLEAN
20custom_fieldsVARCHAR
21has_active_subscriptionBOOLEAN
22last_nameVARCHAR
23deleted_atVARCHAR
24has_canceled_subscriptionBOOLEAN
25parent_account_idVARCHAR
26has_past_due_invoiceBOOLEAN
27usernameVARCHAR

External Resources

Zipstack Cloud features a powerful SQL querying engine on top of many types of connectors, including those from Trino, some custom connectors and connectors from the open source Airbyte project. Some Zipstack cloud connectors are designed to utilize and expand upon Airbyte's connector protocol, but they do not use Airbyte's EL core. Additionally, some parts of the documentation for these connectors have been adapted from the connector documentation found in Airbyte's open source project.