Skip to content

Recurly

Recurly is a subscription management and recurring billing platform for subscriptions, invoicing, payments, and revenue recognition.

Bruin supports Recurly as a source for Ingestr assets.

Configuration

Step 1: Add a connection to .bruin.yml

yaml
connections:
    recurly:
        - name: 'my-recurly'
          api_key: 'your-private-api-key'
          region: 'us'
  • api_key: your Recurly private API key.
  • region (optional): the data center region, either us (default) or eu.

Step 2: Create an asset file

yaml
name: public.recurly
type: ingestr

parameters:
  source_connection: my-recurly
  source_table: 'subscriptions'
  destination: postgres
  • source_connection: the Recurly connection defined in .bruin.yml.
  • source_table: the Recurly table to ingest (see below).

Available Source Tables

Recurly source allows ingesting the following resources:

TablePKInc KeyInc StrategyDetails
accountsidupdated_atmergeCustomer accounts, including billing details, contact info, and custom fields.
subscriptionsidupdated_atmergeRecurring subscriptions, including status, billing cycle, and subscription add-ons.
invoicesidupdated_atmergeInvoices generated for subscriptions and one-off charges, including line items, taxes, and discounts.
transactionsidupdated_atmergePayment, refund, and verification transactions linked to invoices.
plansidupdated_atmergeSubscription plans, including pricing, billing intervals, and add-ons.