Recurly

Recurly is a billing system designed to assist small and medium-sized enterprises in automating and managing their subscription and revenue workflows.

For more information about the API, see Recurly Partner API (v2018-08-09).

See the Schema section for a list of objects available for replication.

Een beknopt overzicht van deze connector, inclusief nuttige koppelingen en ondersteunde functies.

Functie/mogelijkheden	Ondersteuningsdetails
Ondersteunde Qlik Talend Data Integration-projecten	Alleen replicatieprojecten. Gegevenspijplijnprojecten worden niet ondersteund.
Bijwerkmethoden doel	Replicatietaken: Wijzigingen toepassen Wijzigingen opslaan Gegevens tijdelijk opslaan in een datalaketaak: Vastleggen van wijzigingsgegevens (CDC)
Metagegevens beheren	Handmatig metagegevens genereren is niet nodig.
Schema-evolutie	Alleen de bewerking Type kolomgegevens wijzigen wordt ondersteund.
Replicatie van LOB-kolommen (NCLOB, CLOB en BLOB)	Niet ondersteund.
Gepland CDC	Vereist. Zo wordt het doel up-to-date gehouden met wijzigingen in de bron. Voor replicatietaken raadpleegt u CDC plannen voor replicatietaken Voor tussenopslagtaken voor lake, raadpleegt u CDC plannen voor tussenopslagtaken in lake
Meldingen	Gedeeltelijk ondersteund Meldingen instellen voor wijzigingen van de bewerking
Bewaking	Alleen CDC, omdat volledige lading niet relevant is voor deze connector. Een afzonderlijke gegevenstaak bewaken
Automatisch denesten van nettoladingen van JSON-kolommen	Niet ondersteund. Nettoladingen van JSON-kolommen in brongegevensverzamelingen worden niet automatisch gedenest op het doel.

Preparing for authentication

To access your data, you need to authenticate the connection with your account credentials.

Zorg dat het account dat u gebruikt leestoegang heeft voor de tabellen die u wilt ophalen.

To generate the API key:

Make sure you have a role with the Integration permission in Recurly. You need it to generate the API key.
Log into your Recurly account.
Click Admin > Users.
On the Users page, go to Integrations > API Credentials.
Click Add Private API Key.
Fill in the fields:
- Key Name: Enter a name for the API key. For example: Qlik.
- Notes: Enter any notes you want about the API key.
Click Save Changes.
Copy the API key.

Creating the connection

Ga voor meer informatie naar Verbinding maken met SaaS-applicaties.

Vul de vereiste verbindingseigenschappen in.
Geef in Verbindingsnaam een naam voor de verbinding op.
Selecteer Metagegevens verbinding openen om metagegevens te definiëren voor de verbinding nadat deze is gemaakt.
Klik op Maken.

Connection settings
Setting	Description
Data gateway	Selecteer een Data Movement gateway als dit is vereist voor uw usecase. Informatie Dit veld is niet beschikbaar met het Qlik Talend Cloud Starter-abonnement, omdat het geen ondersteuning biedt voor Data Movement gateway. Als u een ander abonnementsniveau hebt en Data Movement gateway niet wilt gebruiken, selecteer dan Geen. Raadpleeg Qlik Data Gateway - Data Movement voor informatie over de voordelen van Data Movement gateway en usecases waarvoor deze is vereist.
Start Date	Voer de datum in, in het formaat `MM/DD/YYYY`, vanaf wanneer de gegevens van uw gegevensbron naar uw doel moeten worden gerepliceerd.
API Key	API key.
Subdomain	Enter your Recurly subdomain. If the full URL of the subdomain is `qlik.recurly.com`, enter qlik into this field.
Quota limit	Enter the percentage of the API rate limit you want to allocate to the integration. Example: 30.

Schema

Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.

The schema and info displayed below is for version 1.

Depending on your destination, table and column names may not appear as they are outlined below.

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

Recurly integration supports replicating custom fields for accounts objects.

Replication Method	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Recurly documentation Recurly API method

Join accounts with	on
adjustments	accounts.id = adjustments.account.id accounts.parent_account_id = adjustments.account.id accounts.shipping_addresses.account_id = adjustments.account.id accounts.id = adjustments.account.parent_account_id accounts.parent_account_id = adjustments.account.parent_account_id accounts.shipping_addresses.account_id = adjustments.account.parent_account_id
billing_info	accounts.id = billing_info.account_id accounts.parent_account_id = billing_info.account_id accounts.shipping_addresses.account_id = billing_info.account_id
coupon_redemptions	accounts.id = coupon_redemptions.account_id accounts.parent_account_id = coupon_redemptions.account_id accounts.shipping_addresses.account_id = coupon_redemptions.account_id
invoices	accounts.id = invoices.account.id accounts.parent_account_id = invoices.account.id accounts.shipping_addresses.account_id = invoices.account.id accounts.id = invoices.account.parent_account_id accounts.parent_account_id = invoices.account.parent_account_id accounts.shipping_addresses.account_id = invoices.account.parent_account_id accounts.id = invoices.credit_payments.refund_transaction.account.id accounts.parent_account_id = invoices.credit_payments.refund_transaction.account.id accounts.shipping_addresses.account_id = invoices.credit_payments.refund_transaction.account.id accounts.id = invoices.line_items.data.shipping_addresses.account_id accounts.parent_account_id = invoices.line_items.data.shipping_addresses.account_id accounts.shipping_addresses.account_id = invoices.line_items.data.shipping_addresses.account_id
subscriptions	accounts.id = subscriptions.shipping_address.account_id accounts.parent_account_id = subscriptions.shipping_address.account_id accounts.shipping_addresses.account_id = subscriptions.shipping_address.account_id
transactions	accounts.id = transactions.account.id accounts.parent_account_id = transactions.account.id accounts.shipping_addresses.account_id = transactions.account.id accounts.id = transactions.account.parent_account_id accounts.parent_account_id = transactions.account.parent_account_id accounts.shipping_addresses.account_id = transactions.account.parent_account_id

address

OBJECT

This is a nested data structure:

city: STRING
country: STRING
first_name: STRING
last_name: STRING
phone: STRING
postal_code: STRING
region: STRING
street1: STRING
street2: STRING

bill_to

STRING

billing_info

OBJECT

This is a nested data structure:

account_id: STRING
address: OBJECT, which is also a nested data structure:
- city: STRING
- country: STRING
- first_name: STRING
- last_name: STRING
- phone: STRING
- postal_code: STRING
- region: STRING
- street1: STRING
- street2: STRING
company: STRING
created_at: DATE-TIME
first_name: STRING
fraud: OBJECT, which is also a nested data structure:
- decision: STRING
- risk_rules_triggered: OBJECT, which is also a nested data structure:
  - score: INTEGER
id: STRING
last_name: STRING
object: STRING
payment_info: OBJECT, which is also a nested data structure:
- card_type: STRING
- exp_month: INTEGER
- exp_year: INTEGER
- first_six: STRING
- last_four: STRING
- object: STRING
updated_at: DATE-TIME
updated_by: OBJECT, which is also a nested data structure:
- country: STRING
- ip: STRING
valid: BOOLEAN
vat_number: STRING

cc_emails

STRING

code

STRING

company

STRING

created_at

DATE-TIME

custom_fields

ARRAY

This is a nested data structure:

name: STRING
value: STRING

deleted_at

DATE-TIME

email

STRING

exemption_certificate

STRING

first_name

STRING

hosted_login_token

STRING

last_name

STRING

object

STRING

parent_account_id

STRING

preferred_locale

STRING

shipping_addresses

ARRAY

This is a nested data structure:

account_id: STRING
city: STRING
company: STRING
country: STRING
created_at: DATE-TIME
email: STRING
first_name: STRING
id: STRING
last_name: STRING
nickname: STRING
postal_code: STRING
region: STRING
street1: STRING
street2: STRING
updated_at: DATE-TIME
vat_number: STRING

state

STRING

tax_exempt

BOOLEAN

updated_at

DATE-TIME

username

STRING

vat_number

STRING

adjustments

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

Replication Method	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Recurly documentation Recurly API method

Join adjustments with	on
accounts	adjustments.account.id = accounts.id adjustments.account.parent_account_id = accounts.id adjustments.account.id = accounts.parent_account_id adjustments.account.parent_account_id = accounts.parent_account_id adjustments.account.id = accounts.shipping_addresses.account_id adjustments.account.parent_account_id = accounts.shipping_addresses.account_id
billing_info	adjustments.account.id = billing_info.account_id adjustments.account.parent_account_id = billing_info.account_id
coupon_redemptions	adjustments.account.id = coupon_redemptions.account_id adjustments.account.parent_account_id = coupon_redemptions.account_id
invoices	adjustments.account.id = invoices.account.id adjustments.account.parent_account_id = invoices.account.id adjustments.account.id = invoices.account.parent_account_id adjustments.account.parent_account_id = invoices.account.parent_account_id adjustments.account.id = invoices.credit_payments.refund_transaction.account.id adjustments.account.parent_account_id = invoices.credit_payments.refund_transaction.account.id adjustments.account.id = invoices.line_items.data.shipping_addresses.account_id adjustments.account.parent_account_id = invoices.line_items.data.shipping_addresses.account_id adjustments.invoice_id = invoices.id adjustments.invoice_id = invoices.credit_payments.applied_to_invoice.id adjustments.invoice_id = invoices.credit_payments.original_invoice.id adjustments.invoice_id = invoices.credit_payments.refund_transaction.invoice.id adjustments.invoice_id = invoices.credit_payments.refund_transaction.voided_by_invoice.id adjustments.invoice_id = invoices.line_items.data.invoice_id adjustments.invoice_id = invoices.subscription_ids adjustments.plan_id = invoices.line_items.data.plan_id adjustments.add_on_id = invoices.line_items.data.add_on_id
subscriptions	adjustments.account.id = subscriptions.shipping_address.account_id adjustments.account.parent_account_id = subscriptions.shipping_address.account_id adjustments.plan_id = subscriptions.pending_change.plan.id adjustments.add_on_id = subscriptions.add_ons.add_on.id
transactions	adjustments.account.id = transactions.account.id adjustments.account.parent_account_id = transactions.account.id adjustments.account.id = transactions.account.parent_account_id adjustments.account.parent_account_id = transactions.account.parent_account_id adjustments.invoice_id = transactions.invoice.id adjustments.invoice_id = transactions.voided_by_invoice.id
plans	adjustments.plan_id = plans.id
plans_add_ons	adjustments.plan_id = plans_add_ons.plan_id adjustments.add_on_id = plans_add_ons.id

account

OBJECT

This is a nested data structure:

bill_to: STRING
code: STRING
company: STRING
email: STRING
first_name: STRING
id: STRING
last_name: STRING
parent_account_id: STRING

accounting_code

STRING

add_on_code

STRING

add_on_id

STRING

amount

NUMBER

created_at

DATE-TIME

credit_applied

NUMBER

credit_reason_code

STRING

currency

STRING

description

STRING

discount

NUMBER

end_date

DATE-TIME

STRING

invoice_id

STRING

invoice_number

STRING

legacy_category

STRING

object

STRING

origin

STRING

original_line_item_invoice_id

STRING

plan_code

STRING

plan_id

STRING

previous_line_item_id

STRING

product_code

STRING

proration_rate

NUMBER

quantity

INTEGER

refund

BOOLEAN

refunded_quantity

INTEGER

shipping_address

OBJECT

This is a nested data structure:

account_id: STRING
city: STRING
company: STRING
country: STRING
created_at: DATE-TIME
email: STRING
first_name: STRING
id: STRING
last_name: STRING
nickname: STRING
phone: STRING
postal_code: STRING
region: STRING
street1: STRING
street2: STRING
updated_at: DATE-TIME
vat_number: STRING

start_date

DATE-TIME

state

STRING

subscription_id

STRING

subtotal

NUMBER

tax

NUMBER

tax_code

STRING

tax_exempt

BOOLEAN

tax_info

STRING

taxable

BOOLEAN

type

STRING

unit_amount

NUMBER

updated_at

DATE-TIME

uuid

STRING

billing_info

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

Recurly integration supports replicating custom fields for billing info objects.

Replication Method	CDC
Primary Key	account_id
Replication Key	updated_at
Useful links	Recurly API method

Join billing_info with	on
accounts	billing_info.account_id = accounts.id billing_info.account_id = accounts.parent_account_id billing_info.account_id = accounts.shipping_addresses.account_id
adjustments	billing_info.account_id = adjustments.account.id billing_info.account_id = adjustments.account.parent_account_id
coupon_redemptions	billing_info.account_id = coupon_redemptions.account_id
invoices	billing_info.account_id = invoices.account.id billing_info.account_id = invoices.account.parent_account_id billing_info.account_id = invoices.credit_payments.refund_transaction.account.id billing_info.account_id = invoices.line_items.data.shipping_addresses.account_id
subscriptions	billing_info.account_id = subscriptions.shipping_address.account_id
transactions	billing_info.account_id = transactions.account.id billing_info.account_id = transactions.account.parent_account_id

account_id

STRING

address

OBJECT

This is a nested data structure:

city: STRING
country: STRING
first_name: STRING
last_name: STRING
phone: STRING
postal_code: STRING
region: STRING
street1: STRING
street2: STRING

company

STRING

created_at

DATE-TIME

custom_fields

ARRAY

This is a nested data structure:

name: STRING
value: STRING

exemption_certificate

STRING

first_name

STRING

fraud

OBJECT

This is a nested data structure:

decision: STRING
risk_rules_triggered: OBJECT, which is also a nested data structure:
- score: INTEGER

STRING

last_name

STRING

object

STRING

payment_method

OBJECT

This is a nested data structure:

account_type: STRING
card_type: STRING
exp_month: INTEGER
exp_year: INTEGER
last_four: STRING
object: STRING
routing_number: INTEGER
routing_number_banl: STRING

updated_at

DATE-TIME

updated_by

OBJECT

This is a nested data structure:

country: STRING
ip: STRING

valid

BOOLEAN

vat_number

STRING

coupon_redemptions

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

Note: In order to replicate this table, you must also set the following tables to replicate:

accounts
subscription
invoices

Replication Method	CDC
Primary Key	id
Replication Key	created_at
	accounts subscription invoices
Useful links	Recurly API method

Join coupon_redemptions with	on
accounts	coupon_redemptions.account_id = accounts.id coupon_redemptions.account_id = accounts.parent_account_id coupon_redemptions.account_id = accounts.shipping_addresses.account_id
adjustments	coupon_redemptions.account_id = adjustments.account.id coupon_redemptions.account_id = adjustments.account.parent_account_id
billing_info	coupon_redemptions.account_id = billing_info.account_id
invoices	coupon_redemptions.account_id = invoices.account.id coupon_redemptions.account_id = invoices.account.parent_account_id coupon_redemptions.account_id = invoices.credit_payments.refund_transaction.account.id coupon_redemptions.account_id = invoices.line_items.data.shipping_addresses.account_id
subscriptions	coupon_redemptions.account_id = subscriptions.shipping_address.account_id coupon_redemptions.coupon.id = subscriptions.coupon_redemptions.coupon.id coupon_redemptions.id = subscriptions.coupon_redemptions.id
transactions	coupon_redemptions.account_id = transactions.account.id coupon_redemptions.account_id = transactions.account.parent_account_id
coupons	coupon_redemptions.coupon.id = coupons.id

account

OBJECT

This is a nested data structure:

bill_to: STRING
code: STRING
company: STRING
email: STRING
first_name: STRING
id: STRING
last_name: STRING
object: STRING
parent_account_id: STRING

account_id

STRING

coupon

OBJECT

This is a nested data structure:

applies_to_all_plans: BOOLEAN
applies_to_non_plan_charges: BOOLEAN
code: STRING
coupon_type: STRING
created_at: DATE-TIME
discount: OBJECT, which is also a nested data structure:
- currencies: ARRAY, which is also a nested data structure:
  - amount: NUMBER
  - currency: STRING
- percent: INTEGER
- trial: OBJECT, which is also a nested data structure:
  - length: INTEGER
  - unit: STRING
type: STRING
duration: STRING
expired_at: DATE-TIME
free_trial_amount: INTEGER
free_trial_unit: STRING
hosted_page_description: STRING
id: STRING
invoice_description: STRING
max_redemptions: INTEGER
max_redemptions_per_account: INTEGER
name: STRING
object: STRING
plans: STRING
plans_names: ARRAY
redeem_by: DATE-TIME
redemption_resource: STRING
state: STRING
temporal_amount: INTEGER
temporal_unit: STRING
unique_coupon_codes_count: INTEGER
updated_at: DATE-TIME

created_at

DATE-TIME

currency

STRING

discounted

STRING

object

STRING

removed_at

DATE-TIME

state

STRING

unique_code_template

STRING

updated_at

DATE-TIME

coupons

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

Replication Method	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Recurly API method

Join coupons with	on
coupon_redemptions	coupons.id = coupon_redemptions.coupon.id
subscriptions	coupons.id = subscriptions.coupon_redemptions.coupon.id

applies_to_all_plans

BOOLEAN

applies_to_non_plan_charges

BOOLEAN

code

STRING

coupon_type

STRING

created_at

DATE-TIME

discount

OBJECT

This is a nested data structure:

currencies: ARRAY, which is also a nested data structure:
- amount: NUMBER
- currency: STRING
percent: INTEGER
trial: OBJECT, which is also a nested data structure:
- length: INTEGER
- unit: STRING
type: STRING

duration

STRING

expired_at

DATE-TIME

free_trial_amount

INTEGER

free_trial_unit

STRING

hosted_page_description

STRING

invoice_description

STRING

max_redemptions

INTEGER

max_redemptions_per_account

INTEGER

name

STRING

object

STRING

plans

ARRAY, STRING

This is a nested data structure:

code: STRING
id: STRING
name: STRING
object: STRING

plans_names

ARRAY

redeem_by

DATE-TIME

redemption_resource

STRING

state

STRING

temporal_amount

INTEGER

temporal_unit

STRING

unique_coupon_codes_count

INTEGER

updated_at

DATE-TIME

invoices

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

Replication Method	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Recurly API method

Join invoices with	on
accounts	invoices.account.id = accounts.id invoices.account.parent_account_id = accounts.id invoices.credit_payments.refund_transaction.account.id = accounts.id invoices.line_items.data.shipping_addresses.account_id = accounts.id invoices.account.id = accounts.parent_account_id invoices.account.parent_account_id = accounts.parent_account_id invoices.credit_payments.refund_transaction.account.id = accounts.parent_account_id invoices.line_items.data.shipping_addresses.account_id = accounts.parent_account_id invoices.account.id = accounts.shipping_addresses.account_id invoices.account.parent_account_id = accounts.shipping_addresses.account_id invoices.credit_payments.refund_transaction.account.id = accounts.shipping_addresses.account_id invoices.line_items.data.shipping_addresses.account_id = accounts.shipping_addresses.account_id
adjustments	invoices.account.id = adjustments.account.id invoices.account.parent_account_id = adjustments.account.id invoices.credit_payments.refund_transaction.account.id = adjustments.account.id invoices.line_items.data.shipping_addresses.account_id = adjustments.account.id invoices.account.id = adjustments.account.parent_account_id invoices.account.parent_account_id = adjustments.account.parent_account_id invoices.credit_payments.refund_transaction.account.id = adjustments.account.parent_account_id invoices.line_items.data.shipping_addresses.account_id = adjustments.account.parent_account_id invoices.id = adjustments.invoice_id invoices.credit_payments.applied_to_invoice.id = adjustments.invoice_id invoices.credit_payments.original_invoice.id = adjustments.invoice_id invoices.credit_payments.refund_transaction.invoice.id = adjustments.invoice_id invoices.credit_payments.refund_transaction.voided_by_invoice.id = adjustments.invoice_id invoices.line_items.data.invoice_id = adjustments.invoice_id invoices.subscription_ids = adjustments.invoice_id invoices.line_items.data.plan_id = adjustments.plan_id invoices.line_items.data.add_on_id = adjustments.add_on_id
billing_info	invoices.account.id = billing_info.account_id invoices.account.parent_account_id = billing_info.account_id invoices.credit_payments.refund_transaction.account.id = billing_info.account_id invoices.line_items.data.shipping_addresses.account_id = billing_info.account_id
coupon_redemptions	invoices.account.id = coupon_redemptions.account_id invoices.account.parent_account_id = coupon_redemptions.account_id invoices.credit_payments.refund_transaction.account.id = coupon_redemptions.account_id invoices.line_items.data.shipping_addresses.account_id = coupon_redemptions.account_id
subscriptions	invoices.account.id = subscriptions.shipping_address.account_id invoices.account.parent_account_id = subscriptions.shipping_address.account_id invoices.credit_payments.refund_transaction.account.id = subscriptions.shipping_address.account_id invoices.line_items.data.shipping_addresses.account_id = subscriptions.shipping_address.account_id invoices.line_items.data.plan_id = subscriptions.pending_change.plan.id invoices.line_items.data.add_on_id = subscriptions.add_ons.add_on.id invoices.credit_payments.refund_transaction.subscription_ids = subscriptions.id invoices.line_items.data.subscription_id = subscriptions.id invoices.credit_payments.refund_transaction.subscription_ids = subscriptions.add_ons.subscription_id invoices.line_items.data.subscription_id = subscriptions.add_ons.subscription_id invoices.credit_payments.refund_transaction.subscription_ids = subscriptions.pending_change.add_ons.subscription_id invoices.line_items.data.subscription_id = subscriptions.pending_change.add_ons.subscription_id invoices.credit_payments.refund_transaction.subscription_ids = subscriptions.pending_change.subscription_id invoices.line_items.data.subscription_id = subscriptions.pending_change.subscription_id
transactions	invoices.account.id = transactions.account.id invoices.account.parent_account_id = transactions.account.id invoices.credit_payments.refund_transaction.account.id = transactions.account.id invoices.line_items.data.shipping_addresses.account_id = transactions.account.id invoices.account.id = transactions.account.parent_account_id invoices.account.parent_account_id = transactions.account.parent_account_id invoices.credit_payments.refund_transaction.account.id = transactions.account.parent_account_id invoices.line_items.data.shipping_addresses.account_id = transactions.account.parent_account_id invoices.id = transactions.invoice.id invoices.credit_payments.applied_to_invoice.id = transactions.invoice.id invoices.credit_payments.original_invoice.id = transactions.invoice.id invoices.credit_payments.refund_transaction.invoice.id = transactions.invoice.id invoices.credit_payments.refund_transaction.voided_by_invoice.id = transactions.invoice.id invoices.line_items.data.invoice_id = transactions.invoice.id invoices.subscription_ids = transactions.invoice.id invoices.id = transactions.voided_by_invoice.id invoices.credit_payments.applied_to_invoice.id = transactions.voided_by_invoice.id invoices.credit_payments.original_invoice.id = transactions.voided_by_invoice.id invoices.credit_payments.refund_transaction.invoice.id = transactions.voided_by_invoice.id invoices.credit_payments.refund_transaction.voided_by_invoice.id = transactions.voided_by_invoice.id invoices.line_items.data.invoice_id = transactions.voided_by_invoice.id invoices.subscription_ids = transactions.voided_by_invoice.id invoices.credit_payments.refund_transaction.subscription_ids = transactions.subscription_ids invoices.line_items.data.subscription_id = transactions.subscription_ids invoices.credit_payments.refund_transaction.id = transactions.id invoices.credit_payments.refund_transaction.original_transaction_id = transactions.id invoices.transactions.id = transactions.id invoices.credit_payments.refund_transaction.id = transactions.original_transaction_id invoices.credit_payments.refund_transaction.original_transaction_id = transactions.original_transaction_id invoices.transactions.id = transactions.original_transaction_id
plans	invoices.line_items.data.plan_id = plans.id
plans_add_ons	invoices.line_items.data.plan_id = plans_add_ons.plan_id invoices.line_items.data.add_on_id = plans_add_ons.id

account

OBJECT

This is a nested data structure:

bill_to: STRING
code: STRING
company: STRING
email: STRING
first_name: STRING
id: STRING
last_name: STRING
object: STRING
parent_account_id: STRING

address

OBJECT

This is a nested data structure:

city: STRING
company: STRING
country: STRING
first_name: STRING
last_name: STRING
name_on_account: STRING
phone: STRING
postal_code: STRING
region: STRING
street1: STRING
street2: STRING

balance

NUMBER

closed_at

DATE-TIME

collection_method

STRING

created_at

DATE-TIME

credit_payments

ARRAY

This is a nested data structure:

account: OBJECT, which is also a nested data structure:
- code: STRING
- company: STRING
- email: STRING
- first_name: STRING
- id: STRING
- last_name: STRING
- object: STRING
action: STRING
amount: NUMBER
applied_to_invoice: OBJECT
- id: STRING
- number: STRING
- object: STRING
- state: STRING
- type: STRING
created_at: DATE-TIME
currency: STRING
id: STRING
object: STRING
original_credit_payment_id: STRING
original_invoice: OBJECT, which is also a nested data structure:
- id: STRING
- number: STRING
- object: STRING
- state: STRING
- type: STRING
refund_transaction: OBJECT, which is also a nested data structure:
- account: OBJECT, which is also a nested data structure:
  - code: STRING
  - company: STRING
  - email: STRING
  - first_name: STRING
  - id: STRING
  - last_name: STRING
  - object: STRING
- amount: NUMBER
- avs_check: STRING
- billing_address: OBJECT, which is also a nested data structure:
  - city: STRING
  - country: STRING
  - first_name: STRING
  - last_name: STRING
  - phone: STRING
  - postal_code: STRING
  - region: STRING
  - street1: STRING
  - street2: STRING
- collected_at: DATE-TIME
- collection_method: STRING
- created_at: DATE-TIME
- currency: STRING
- customer_message: STRING
- customer_message_locale: STRING
- cvv_check: STRING
- gateway_approval_code: STRING
- gateway_message: STRING
- gateway_reference: STRING
- gateway_response_code: STRING
- gateway_response_time: STRING
- gateway_response_values: OBJECT, which is also a nested data structure.
- id: STRING
- invoice: OBJECT, which is also a nested data structure:
  - id: STRING
  - number: STRING
  - object: STRING
  - state: STRING
  - type: STRING
- ip_address_country: STRING
- ip_address_v4: STRING
- object: STRING
- origin: STRING
- original_transaction_id: STRING
- payment_gateway: OBJECT, which is also a nested data structure:
  - id: STRING
  - name: STRING
  - object: STRING
  - type: STRING
- payment_method: OBJECT, which is also a nested data structure:
  - card_type: STRING
  - exp_month: INTEGER
  - exp_year: INTEGER
  - first_six: STRING
  - last_four: STRING
  - object: STRING
- refunded: BOOLEAN
- status: STRING
- status_code: STRING
- status_message: STRING
- subscription_ids: ARRAY, which is also a nested data structure.
- success: BOOLEAN
- type: STRING
- uuid: STRING
- voided_at: DATE-TIME
- voided_by_invoice: OBJECT
  - id: STRING
  - number: STRING
  - object: STRING
  - state: STRING
  - type: STRING
updated_at: DATE-TIME
uuid: STRING
voided_at: DATE-TIME

currency

STRING

customer_notes

STRING

discount

NUMBER

due_at

DATE-TIME

STRING

line_items

OBJECT

This is a nested data structure:

data: ARRAY, which is also a nested data structure:
- account: OBJECT, which is also a nested data structure:
  - bill_to: STRING
  - code: STRING
  - company: STRING
  - email: STRING
  - first_name: STRING
  - id: STRING
  - last_name: STRING
  - object: STRING
  - parent_account_id: STRING
- accounting_code: STRING
- add_on_code: STRING
- add_on_id: STRING
- amount: NUMBER
- created_at: DATE-TIME
- credit_applied: NUMBER
- credit_reason_code: STRING
- currency: STRING
- description: STRING
- discount: NUMBER
- end_date: DATE-TIME
- id: STRING
- invoice_id: STRING
- invoice_number: STRING
- legacy_category: STRING
- object: STRING
- origin: STRING
- original_line_item_invoice_id: STRING
- plan_code: STRING
- plan_id: STRING
- previous_line_item_id: STRING
- product_code: STRING
- proration_rate: NUMBER
- quantity: INTEGER
- refund: BOOLEAN
- refunded_quantity: INTEGER
- shipping_addresses: ARRAY, which is also a nested data structure:
  - account_id: STRING
  - city: STRING
  - company: STRING
  - country: STRING
  - created_at: DATE-TIME
  - email: STRING
  - first_name: STRING
  - id: STRING
  - last_name: STRING
  - nickname: STRING
  - phone: STRING
  - postal_code: STRING
  - region: STRING
  - street1: STRING
  - street2: STRING
  - updated_at: DATE-TIME
  - vat_number: STRING
- start_date: DATE-TIME
- state: STRING
- subscription_id: STRING
- subtotal: NUMBER
- tax: NUMBER
- tax_code: STRING
- tax_exempt: STRING
- tax_info: OBJECT, which is also a nested data structure:
  - rate: NUMBER
  - region: STRING
  - type: STRING
- taxable: BOOLEAN
- type: STRING
- unit_amount: NUMBER
- updated_at: DATE-TIME
- uuid: STRING
has_more: BOOLEAN
next: STRING
object: STRING

net_terms

NUMBER

number

STRING

object

STRING

origin

STRING

paid

NUMBER

po_number

STRING

previous_invoice_id

STRING

refundable_amount

NUMBER

state

STRING

subscription_ids

ARRAY

subtotal

NUMBER

tax

NUMBER

tax_info

OBJECT

This is a nested data structure:

rate: NUMBER
region: STRING
type: STRING

terms_and_conditions

STRING

total

NUMBER

transactions

ARRAY

This is a nested data structure:

account: OBJECT, which is also a nested data structure:
- bill_to: STRING
- code: STRING
- company: STRING
- email: STRING
- first_name: STRING
- id: STRING
- last_name: STRING
- object: STRING
- parent_account_id: STRING
amount: NUMBER
avs_check: STRING
billing_address: OBJECT
- city: STRING
- country: STRING
- first_name: STRING
- last_name: STRING
- phone: STRING
- postal_code: STRING
- region: STRING
- street1: STRING
- street2: STRING
collected_at: DATE-TIME
collection_method: STRING
created_at: DATE-TIME
currency: STRING
customer_message: STRING
customer_message_locale: STRING
cvv_check: STRING
gateway_approval_code: STRING
gateway_message: STRING
gateway_reference: STRING
gateway_response_code: STRING
gateway_response_time: NUMBER
gateway_response_values: OBJECT, which is also a nested data structure.
id: STRING
invoice: OBJECT, which is also a nested data structure:
- id: STRING
- number: STRING
- object: STRING
- state: STRING
- type: STRING
ip_address_country: STRING
ip_address_v4: STRING
object: STRING
origin: STRING
original_transaction_id: STRING
payment_gateway: OBJECT, which is also a nested data structure:
- id: STRING
- name: STRING
- object: STRING
- type: STRING
payment_method: OBJECT, which is also a nested data structure:
- card_type: STRING
- exp_month: INTEGER
- exp_year: INTEGER
- first_six: STRING
- last_four: STRING
- object: STRING
refunded: BOOLEAN
status: STRING
status_code: STRING
status_message: STRING
subscription_ids: ARRAY
success: BOOLEAN
type: STRING
uuid: STRING
voided_at: DATE-TIME
voided_by_invoice: OBJECT, which is also a nested data structure:
- id: STRING
- number: STRING
- object: STRING
- state: STRING
- type: STRING

type

STRING

updated_at

DATE-TIME

vat_number

STRING

vat_reverse_charge_notes

STRING

plans

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

Replication Method	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Recurly API method

Join plans with	on
adjustments	plans.id = adjustments.plan_id
invoices	plans.id = invoices.line_items.data.plan_id
plans_add_ons	plans.id = plans_add_ons.plan_id
subscriptions	plans.id = subscriptions.pending_change.plan.id

accounting_code

STRING

auto_renew

BOOLEAN

code

STRING

created_at

DATE-TIME

currencies

ARRAY

This is a nested data structure:

currency: STRING
setup_free: NUMBER
unit_amount: NUMBER

deleted_at

DATE-TIME

description

STRING

hosted_pages

OBJECT

This is a nested data structure:

bypass_confirmation: BOOLEAN
cancel_url: STRING
display_quantity: BOOLEAN
success_url: STRING

STRING

interval_length

INTEGER

interval_unit

STRING

name

STRING

object

STRING

setup_fee_accounting_code

STRING

state

STRING

tax_code

STRING

tax_exempt

BOOLEAN

total_billing_cycles

INTEGER

trial_length

INTEGER

trial_unit

STRING

updated_at

DATE-TIME

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

Replication Method	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Recurly API method

Join plans_add_ons with	on
adjustments	plans_add_ons.plan_id = adjustments.plan_id plans_add_ons.id = adjustments.add_on_id
invoices	plans_add_ons.plan_id = invoices.line_items.data.plan_id plans_add_ons.id = invoices.line_items.data.add_on_id
plans	plans_add_ons.plan_id = plans.id
subscriptions	plans_add_ons.plan_id = subscriptions.pending_change.plan.id plans_add_ons.id = subscriptions.add_ons.add_on.id

accounting_code

STRING

code

STRING

created_at

DATE-TIME

currencies

ARRAY

This is a nested data structure:

currency: STRING
unit_amount: NUMBER

default_quantity

INTEGER

deleted_at

DATE-TIME

display_quantity

BOOLEAN

STRING

name

STRING

object

STRING

plan_id

STRING

state

STRING

tax_code

STRING

updated_at

DATE-TIME

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

Recurly integration supports replicating custom fields for subscription objects.

Replication Method	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Recurly API method

Join subscriptions with	on
accounts	subscriptions.shipping_address.account_id = accounts.id subscriptions.shipping_address.account_id = accounts.parent_account_id subscriptions.shipping_address.account_id = accounts.shipping_addresses.account_id
adjustments	subscriptions.shipping_address.account_id = adjustments.account.id subscriptions.shipping_address.account_id = adjustments.account.parent_account_id subscriptions.pending_change.plan.id = adjustments.plan_id subscriptions.add_ons.add_on.id = adjustments.add_on_id
billing_info	subscriptions.shipping_address.account_id = billing_info.account_id
coupon_redemptions	subscriptions.shipping_address.account_id = coupon_redemptions.account_id subscriptions.coupon_redemptions.coupon.id = coupon_redemptions.coupon.id subscriptions.coupon_redemptions.id = coupon_redemptions.id
invoices	subscriptions.shipping_address.account_id = invoices.account.id subscriptions.shipping_address.account_id = invoices.account.parent_account_id subscriptions.shipping_address.account_id = invoices.credit_payments.refund_transaction.account.id subscriptions.shipping_address.account_id = invoices.line_items.data.shipping_addresses.account_id subscriptions.pending_change.plan.id = invoices.line_items.data.plan_id subscriptions.add_ons.add_on.id = invoices.line_items.data.add_on_id subscriptions.id = invoices.credit_payments.refund_transaction.subscription_ids subscriptions.add_ons.subscription_id = invoices.credit_payments.refund_transaction.subscription_ids subscriptions.pending_change.add_ons.subscription_id = invoices.credit_payments.refund_transaction.subscription_ids subscriptions.pending_change.subscription_id = invoices.credit_payments.refund_transaction.subscription_ids subscriptions.id = invoices.line_items.data.subscription_id subscriptions.add_ons.subscription_id = invoices.line_items.data.subscription_id subscriptions.pending_change.add_ons.subscription_id = invoices.line_items.data.subscription_id subscriptions.pending_change.subscription_id = invoices.line_items.data.subscription_id
transactions	subscriptions.shipping_address.account_id = transactions.account.id subscriptions.shipping_address.account_id = transactions.account.parent_account_id subscriptions.id = transactions.subscription_ids subscriptions.add_ons.subscription_id = transactions.subscription_ids subscriptions.pending_change.add_ons.subscription_id = transactions.subscription_ids subscriptions.pending_change.subscription_id = transactions.subscription_ids
coupons	subscriptions.coupon_redemptions.coupon.id = coupons.id
plans	subscriptions.pending_change.plan.id = plans.id
plans_add_ons	subscriptions.pending_change.plan.id = plans_add_ons.plan_id subscriptions.add_ons.add_on.id = plans_add_ons.id

account

OBJECT

This is a nested data structure:

bill_to: STRING
code: STRING
company: STRING
email: STRING
first_name: STRING
id: STRING
last_name: STRING
object: STRING
parent_account_id: STRING

activated_at

DATE-TIME

add_ons

ARRAY

This is a nested data structure:

add_on: OBJECT
- accounting_code: STRING
- code: STRING
- id: STRING
- name: STRING
- object: STRING
created_at: DATE-TIME
expired_at: DATE-TIME
id: STRING
object: STRING
quantity: NUMBER
subscription_id: STRING
unit_amount: NUMBER
updated_at: DATE-TIME

add_ons_total

NUMBER

auto_renew

BOOLEAN

bank_account_authorized_at

DATE-TIME

canceled_at

DATE-TIME

collection_method

STRING

coupon_redemptions

ARRAY

This is a nested data structure:

coupon: OBJECT, which is also a nested data structure:
- code: STRING
- coupon_type: STRING
- discount: OBJECT, which is also a nested data structure:
  - currencies: ARRAY, which is also a nested data structure:
    - amount: NUMBER
    - currency: STRING
  - percent: INTEGER
  - discount: OBJECT, which is also a nested data structure:
    - trial: OBJECT, , which is also a nested data structure:
      - length: NUMBER
      - unit: STRING
    - type: STRING
- expired_at: DATE-TIME
- id: STRING
- name: STRING
- object: STRING
- state: STRING
created_at: DATE-TIME
discounted: STRING
id: STRING
object: STRING
state: STRING

created_at

DATE-TIME

currency

STRING

current_period_ends_at

DATE-TIME

current_period_started_at

DATE-TIME

current_term_ends_at

DATE-TIME

current_term_started_at

DATE-TIME

custom_fields

ARRAY

This is a nested data structure:

name: STRING
value: STRING

customer_notes

STRING

expiration_reason

STRING

expires_at

DATE-TIME

STRING

net_terms

INTEGER

object

STRING

paused_at

DATE-TIME

pending_change

OBJECT

This is a nested data structure:

activate_at: DATE-TIME
activated: BOOLEAN
add_ons: ARRAY, which is also a nested data structure:
- add_on: OBJECT, which is also a nested data structure:
  - accounting_code: STRING
  - code: STRING
  - id: STRING
  - name: STRING
  - object: STRING
- created_at: DATE-TIME
- expired_at: DATE-TIME
- id: STRING
- object: STRING
- quantity: NUMBER
- subscription_id: STRING
- unit_amount: NUMBER
- updated_at: DATE-TIME
created_at: DATE-TIME
deleted_at: BOOLEAN
id: STRING
object: STRING
plan: OBJECT, which is also a nested data structure:
- code: STRING
- id: STRING
- name: STRING
- object: STRING
quantity: NUMBER
subscription_id: STRING
unit_amount: NUMBER
updated_at: DATE-TIME

plan

OBJECT

This is a nested data structure:

code: STRING
id: STRING
name: STRING
object: STRING

po_number

STRING

quantity

INTEGER

remaining_billing_cycles

INTEGER

remaining_pause_cycles

INTEGER

renewal_billing_cycles

INTEGER

shipping_address

OBJECT

This is a nested data structure:

account_id: STRING
city: STRING
company: STRING
country: STRING
created_at: DATE-TIME
email: STRING
first_name: STRING
id: STRING
last_name: STRING
nickname: STRING
postal_code: STRING
region: STRING
street1: STRING
street2: STRING
updated_at: DATE-TIME
vat_number: STRING

state

STRING

subtotal

NUMBER

terms_and_conditions

STRING

total_billing_cycles

INTEGER

trial_ends_at

DATE-TIME

trial_started_at

DATE-TIME

unit_amount

NUMBER

updated_at

DATE-TIME

uuid

STRING

transactions

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

Replication Method	CDC
Primary Key	id
Replication Key	collected_at
Useful links	Recurly API method

Join transactions with	on
accounts	transactions.account.id = accounts.id transactions.account.parent_account_id = accounts.id transactions.account.id = accounts.parent_account_id transactions.account.parent_account_id = accounts.parent_account_id transactions.account.id = accounts.shipping_addresses.account_id transactions.account.parent_account_id = accounts.shipping_addresses.account_id
adjustments	transactions.account.id = adjustments.account.id transactions.account.parent_account_id = adjustments.account.id transactions.account.id = adjustments.account.parent_account_id transactions.account.parent_account_id = adjustments.account.parent_account_id transactions.invoice.id = adjustments.invoice_id transactions.voided_by_invoice.id = adjustments.invoice_id
billing_info	transactions.account.id = billing_info.account_id transactions.account.parent_account_id = billing_info.account_id
coupon_redemptions	transactions.account.id = coupon_redemptions.account_id transactions.account.parent_account_id = coupon_redemptions.account_id
invoices	transactions.account.id = invoices.account.id transactions.account.parent_account_id = invoices.account.id transactions.account.id = invoices.account.parent_account_id transactions.account.parent_account_id = invoices.account.parent_account_id transactions.account.id = invoices.credit_payments.refund_transaction.account.id transactions.account.parent_account_id = invoices.credit_payments.refund_transaction.account.id transactions.account.id = invoices.line_items.data.shipping_addresses.account_id transactions.account.parent_account_id = invoices.line_items.data.shipping_addresses.account_id transactions.invoice.id = invoices.id transactions.voided_by_invoice.id = invoices.id transactions.invoice.id = invoices.credit_payments.applied_to_invoice.id transactions.voided_by_invoice.id = invoices.credit_payments.applied_to_invoice.id transactions.invoice.id = invoices.credit_payments.original_invoice.id transactions.voided_by_invoice.id = invoices.credit_payments.original_invoice.id transactions.invoice.id = invoices.credit_payments.refund_transaction.invoice.id transactions.voided_by_invoice.id = invoices.credit_payments.refund_transaction.invoice.id transactions.invoice.id = invoices.credit_payments.refund_transaction.voided_by_invoice.id transactions.voided_by_invoice.id = invoices.credit_payments.refund_transaction.voided_by_invoice.id transactions.invoice.id = invoices.line_items.data.invoice_id transactions.voided_by_invoice.id = invoices.line_items.data.invoice_id transactions.invoice.id = invoices.subscription_ids transactions.voided_by_invoice.id = invoices.subscription_ids transactions.subscription_ids = invoices.credit_payments.refund_transaction.subscription_ids transactions.subscription_ids = invoices.line_items.data.subscription_id transactions.id = invoices.credit_payments.refund_transaction.id transactions.original_transaction_id = invoices.credit_payments.refund_transaction.id transactions.id = invoices.credit_payments.refund_transaction.original_transaction_id transactions.original_transaction_id = invoices.credit_payments.refund_transaction.original_transaction_id transactions.id = invoices.transactions.id transactions.original_transaction_id = invoices.transactions.id
subscriptions	transactions.account.id = subscriptions.shipping_address.account_id transactions.account.parent_account_id = subscriptions.shipping_address.account_id transactions.subscription_ids = subscriptions.id transactions.subscription_ids = subscriptions.add_ons.subscription_id transactions.subscription_ids = subscriptions.pending_change.add_ons.subscription_id transactions.subscription_ids = subscriptions.pending_change.subscription_id

account

OBJECT

This is a nested data structure:

bill_to: STRING
code: STRING
company: STRING
email: STRING
first_name: STRING
id: STRING
last_name: STRING
object: STRING
parent_account_id: STRING

amount

NUMBER

avs_check

STRING

billing_address

OBJECT

This is a nested data structure:

city: STRING
country: STRING
first_name: STRING
last_name: STRING
phone: STRING
postal_code: STRING
region: STRING
street1: STRING
street2: STRING

collected_at

DATE-TIME

collection_method

STRING

created_at

DATE-TIME

currency

STRING

customer_message

STRING

customer_message_locale

STRING

cvv_check

STRING

gateway_approval_code

STRING

gateway_message

STRING

gateway_reference

STRING

gateway_response_code

STRING

gateway_response_time

NUMBER

gateway_response_values

OBJECT

This is a nested data structure:

amount: NUMBER
amount_refunded: NUMBER
card_fingerprint: STRING
card_type: STRING
currency: STRING
description: STRING
livemode: STRING

STRING

invoice

OBJECT

This is a nested data structure:

id: STRING
number: STRING
object: STRING
state: STRING
type: STRING

ip_address_country

STRING

ip_address_v4

STRING

object

STRING

origin

STRING

original_transaction_id

STRING

payment_gateway

OBJECT

This is a nested data structure:

id: STRING
name: STRING
object: STRING
type: STRING

payment_method

OBJECT

This is a nested data structure:

card_type: STRING
exp_month: INTEGER
exp_year: INTEGER
first_six: STRING
last_four: STRING
object: STRING

refunded

BOOLEAN

status

STRING

status_code

STRING

status_message

STRING

subscription_ids

ARRAY

success

BOOLEAN

type

STRING

uuid

STRING

voided_at

DATE-TIME

voided_by_invoice

OBJECT

This is a nested data structure:

id: STRING
number: STRING
object: STRING
state: STRING
type: STRING

Was deze pagina nuttig?

Als u problemen ervaart op deze pagina of de inhoud onjuist is – een tikfout, een ontbrekende stap of een technische fout – laat het ons weten!

Geef hier uw feedback