Skip to content

Paddle

Paddle is a merchant-of-record billing platform for payments, subscriptions, and invoicing.

Bruin supports Paddle as a source for Ingestr assets.

Configuration

Step 1: Add a connection to .bruin.yml

yaml
connections:
    paddle:
        - name: 'my-paddle'
          api_key: 'pdl_live_xxx'
  • api_key: your Paddle API key.

Step 2: Create an asset file

yaml
name: public.paddle
type: ingestr

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

Tables

Paddle source allows ingesting the following resources:

TablePKInc KeyInc StrategyDetails
customersidupdated_atmergeCustomer records, including name, email, and locale.
productsidupdated_atmergeProducts you sell, including name, description, and tax category.
pricesidupdated_atmergePrices attached to products, including billing cycle and currency.
discountsidupdated_atmergeDiscounts and coupon codes that can be applied to transactions and subscriptions.
transactionsidupdated_atmergeTransactions, the core billing record. Each transaction carries the invoice_number Paddle generates, so this table is where invoice data lives.
subscriptionsidupdated_atmergeRecurring subscriptions, including status, billing cycle, and scheduled changes.
adjustmentsidupdated_atmergeAdjustments such as refunds, credits, and chargebacks against transactions.