Recurly
Keep Recurly in step with your orders, invoices and payments without re-keying, with the right person approving what changes.
64 ways to read, 20 ways to write, each write switched on by you.
Quality checks
Built and tested with example responses.
- Ready to connect: doneEvery listed action is built in.
- Built and tested with example responses: doneEach action is built from the provider’s published API and tested against example responses, errors, rate limits and paging.
Connected, approved, proven.
The things teams do most with Recurly, an example flow with a person in the loop, and what Nexra keeps as proof.
Top actions
- Create account noteApproval by rule
- Create accountApproval by rule
- Get account balanceRead
Example flow
- Recurly · Get account balanceDone
- Recurly · Create account noteNeeds approval
- Nexra · Record the decision and result in the evidence chainProven
Example workflow. Routine runs go through on their own. Only a change your rules flag, such as one over a limit you set, waits for the right person, who sees the exact change and the rule before it reaches Recurly.
What gets logged
- Whether it ran on its own or who approved it, and under which rule
- A fingerprint of the exact request sent to Recurly
- Recurly's reply: what it created or changed
- One entry in the evidence chain, linked to the one before
Try this in the sandbox
Run the whole flow with test data in your sandbox, then connect a Recurly test account before you go live.
For developers
Technical detail
Recurly accounts, shipping addresses, acquisition, subscriptions, plans, add-ons, items, coupons, usage and notes; invoices, line items, redemptions, transactions and exports.
Recurly API docs- Source actions
- 64
- Destination actions
- 20
- Data types
- 43
What you can map
Reads are always available. Writes are off until you switch them on for a connection, and governed writes follow your policies.
Account acquisitions2
- Get account acquisitionSource
How an account was acquired: channel, subchannel, campaign and cost.
- Update account acquisitionDestinationProvider duplicate protectionApproval before production
Sets or updates an account's acquisition channel, campaign and cost.
Account balances1
- Get account balanceSource
An account's balance per currency, available credit and past-due flag.
Account invoices1
- List invoices of an accountSourceIncremental
Invoices of an account with cursor pagination, sorted by updated_at with begin_time for incremental reads.
Account line items1
- List line items of an accountSourceIncremental
Line items of an account with cursor pagination, sorted by updated_at with begin_time for incremental reads.
Account notes3
- Create account noteDestinationProvider duplicate protectionApproval before production
Adds a note to an account.
- Get account noteSource
One account note by ID.
- List notes of an accountSource
Notes of an account with cursor pagination.
Account subscriptions1
- List subscriptions of an accountSourceIncremental
Subscriptions of an account with cursor pagination, sorted by updated_at with begin_time for incremental reads.
Account transactions1
- List transactions of an account (read only)SourceIncremental
Transactions of an account (read only) with cursor pagination, sorted by updated_at with begin_time for incremental reads.
Accounts4
- Create accountDestinationProvider duplicate protectionApproval before production
Creates an account with contact details, address and custom fields. Billing info is never sent.
- Get accountSource
One account by ID (Account ID or code-<account code>).
- List accountsSourceIncremental
Accounts with cursor pagination, sorted by updated_at with begin_time for incremental reads.
- Update accountDestinationProvider duplicate protectionApproval before production
Updates supplied account fields.
Acquisitions1
- List account acquisition recordsSourceIncremental
Account acquisition records with cursor pagination, sorted by updated_at with begin_time for incremental reads.
Add ons2
- Get add-onSource
One add-on by ID (Add-on ID or code-<add-on code>).
- List add-ons across all plansSourceIncremental
Add-ons across all plans with cursor pagination, sorted by updated_at with begin_time for incremental reads.
Business entities2
- Get business entitySource
One business entity by ID (Business entity ID or code-<code>).
- List business entitiesSource
Business entities with cursor pagination.
Child accounts1
- List child accounts of a parent accountSourceIncremental
Child accounts of a parent account with cursor pagination, sorted by updated_at with begin_time for incremental reads.
Coupon redemptions1
- List coupon redemptions of an accountSourceIncremental
Coupon redemptions of an account with cursor pagination, sorted by updated_at with begin_time for incremental reads.
Coupons4
- Create couponDestinationProvider duplicate protectionApproval before production
Creates a single-code or bulk coupon with a fixed, percent or free-trial discount.
- Get couponSource
One coupon by ID (Coupon ID or code-<coupon code>).
- List couponsSourceIncremental
Coupons with cursor pagination, sorted by updated_at with begin_time for incremental reads.
- Update couponDestinationProvider duplicate protectionApproval before production
Updates the coupon fields Recurly allows to change after creation.
Credit invoices1
- List credit invoices (credit notes)SourceIncremental
Credit invoices (credit notes) with cursor pagination, sorted by updated_at with begin_time for incremental reads.
Credit payments2
- Get credit paymentSource
One credit payment by ID.
- List credit payments (read only)SourceIncremental
Credit payments (read only) with cursor pagination, sorted by updated_at with begin_time for incremental reads.
Custom field definitions2
- Get custom field definitionSource
One custom field definition by ID.
- List custom field definitionsSourceIncremental
Custom field definitions with cursor pagination, sorted by updated_at with begin_time for incremental reads.
Entitlements1
- List entitlements granted to an accountSource
Entitlements granted to an account with cursor pagination.
Export dates1
- List export datesSource
Dates with automated export files available to download.
Export files1
- List export filesSource
Automated export files for one date, with temporary download links.
General ledger accounts2
- Get general ledger accountSource
One general ledger account by ID.
- List general ledger accounts (read only)Source
General ledger accounts (read only) with cursor pagination.
Invoice coupon redemptions1
- List coupon redemptions applied to an invoiceSourceIncremental
Coupon redemptions applied to an invoice with cursor pagination, sorted by updated_at with begin_time for incremental reads.
Invoice line items1
- List line items of an invoiceSourceIncremental
Line items of an invoice with cursor pagination, sorted by updated_at with begin_time for incremental reads.
Invoice templates2
- Get invoice templateSource
One invoice template by ID.
- List invoice templatesSource
Invoice templates with cursor pagination.
Invoices3
- Get invoiceSource
One invoice by ID (Invoice ID or number-<invoice number>).
- List invoicesSourceIncremental
Invoices with cursor pagination, sorted by updated_at with begin_time for incremental reads.
- Update invoice detailsDestinationProvider duplicate protectionApproval before production
Updates an invoice's PO number, notes, terms and net terms. Amounts are unchanged.
Items4
- Create itemDestinationProvider duplicate protectionApproval before production
Creates a catalogue item with prices per currency.
- Get itemSource
One item by ID (Item ID or code-<item code>).
- List itemsSourceIncremental
Items with cursor pagination, sorted by updated_at with begin_time for incremental reads.
- Update itemDestinationProvider duplicate protectionApproval before production
Updates supplied item fields.
Line items2
- Get line itemSource
One line item by ID.
- List line itemsSourceIncremental
Line items with cursor pagination, sorted by updated_at with begin_time for incremental reads.
Measured units3
- Create measured unitDestinationProvider duplicate protectionApproval before production
Creates a measured unit for usage add-ons.
- List measured unitsSourceIncremental
Measured units with cursor pagination, sorted by updated_at with begin_time for incremental reads.
- Update measured unitDestinationProvider duplicate protectionApproval before production
Updates a measured unit.
Plan add ons4
- Create plan add-onDestinationProvider duplicate protectionApproval before production
Creates a fixed or usage add-on on a plan.
- Get plan add-onSource
One plan add-on by ID (Add-on ID or code-<add-on code>).
- List add-ons of a planSourceIncremental
Add-ons of a plan with cursor pagination, sorted by updated_at with begin_time for incremental reads.
- Update plan add-onDestinationProvider duplicate protectionApproval before production
Updates supplied add-on fields and prices.
Plans4
- Create planDestinationProvider duplicate protectionApproval before production
Creates a plan with prices per currency, billing interval and trial.
- Get planSource
One plan by ID (Plan ID or code-<plan code>).
- List plansSourceIncremental
Plans with cursor pagination, sorted by updated_at with begin_time for incremental reads.
- Update planDestinationProvider duplicate protectionApproval before production
Updates supplied plan fields and prices.
Price segments2
- Get price segmentSource
One price segment by ID (Price segment ID or code-<code>).
- List price segmentsSource
Price segments with cursor pagination.
Related invoices1
- List credit or charge invoices related to an invoiceSource
Credit or charge invoices related to an invoice with cursor pagination.
Renewal previews1
- Preview subscription renewalSource
The invoice Recurly would issue at the subscription's next renewal.
Shipping addresses4
- Create shipping addressDestinationProvider duplicate protectionApproval before production
Adds a shipping address to an account.
- Get shipping addressSource
One shipping address by ID.
- List shipping addresses of an accountSourceIncremental
Shipping addresses of an account with cursor pagination, sorted by updated_at with begin_time for incremental reads.
- Update shipping addressDestinationProvider duplicate protectionApproval before production
Updates supplied fields of an account's shipping address.
Shipping methods2
- Get shipping methodSource
One shipping method by ID (Shipping method ID or code-<code>).
- List shipping methods (read only)SourceIncremental
Shipping methods (read only) with cursor pagination, sorted by updated_at with begin_time for incremental reads.
Subscription changes1
- Get pending subscription changeSource
The change scheduled for a subscription's next renewal, if any.
Subscription coupon redemptions1
- List coupon redemptions of a subscriptionSourceIncremental
Coupon redemptions of a subscription with cursor pagination, sorted by updated_at with begin_time for incremental reads.
Subscription invoices1
- List invoices of a subscriptionSourceIncremental
Invoices of a subscription with cursor pagination, sorted by updated_at with begin_time for incremental reads.
Subscription line items1
- List line items of a subscriptionSourceIncremental
Line items of a subscription with cursor pagination, sorted by updated_at with begin_time for incremental reads.
Subscriptions4
- Create subscriptionDestinationProvider duplicate protectionApproval before production
Creates a subscription for an existing account and plan with manual (invoice) collection.
- Get subscriptionSource
One subscription by ID (Subscription ID or uuid-<uuid>).
- List subscriptionsSourceIncremental
Subscriptions with cursor pagination, sorted by updated_at with begin_time for incremental reads.
- Update subscriptionDestinationProvider duplicate protectionApproval before production
Updates subscription terms, renewal settings, PO number, notes and custom fields. Plan, price and quantity changes are not included.
Transactions2
- Get transactionSource
One transaction by ID (Transaction ID or uuid-<uuid>).
- List transactions (read only)SourceIncremental
Transactions (read only) with cursor pagination, sorted by updated_at with begin_time for incremental reads.
Unique coupon codes2
- Get unique coupon codeSource
One unique coupon code by ID (Unique code ID or code-<code>).
- List unique codes of a bulk couponSourceIncremental
Unique codes of a bulk coupon with cursor pagination, sorted by updated_at with begin_time for incremental reads.
Usage3
- Record usageDestinationNot retried automaticallyApproval before production
Records usage against a usage add-on on a subscription.
- Get usage recordSource
One usage record by ID.
- List usage records of a subscription add-onSource
Usage records of a subscription add-on with cursor pagination.
Access and limits
- Authentication
- Recurly private API key (HTTP Basic username)
- Plans and access
- API access is included on Recurly plans; keys are created per site. Private API keys grant full site access unless scoped in Recurly. Usage operations require usage-based add-ons on the site.
- Test environment
- Recurly sandbox sites use the same API hosts with sandbox API keys.
- Rate limits
- Sandbox sites allow 400 requests per minute and production sites 1,000 GET requests per minute over a sliding 5-minute window; Recurly returns HTTP 429 and Nexra backs off.
- Pagination
- limit (max 200) with has_more and next path; incremental reads use sort=updated_at and begin_time.
- Provider events
- Recurly webhook notifications for account, subscription, invoice and payment events. Flows can start the moment something happens: when a payment succeeds; when a payment fails; when a refund is processed; when a new subscription starts.
Before you build a flow
- Subscription create always sends collection_method=manual so Recurly issues an invoice with net terms instead of charging a stored payment method during the flow. Change collection in Recurly if automatic collection is required.
- Subscription update covers terms, renewal, PO number, notes and custom fields; plan or quantity changes (subscription changes), next bill date and collection method changes are not automated.
- Invoice create (which collects pending charges), purchases, pending line items, refunds, voids, invoice collection, cancellations, pauses, reactivation, billing info and account redaction are intentionally not automated.
- Invoice update changes PO number, notes, terms and net terms only.
- Coupon update supports the fields Recurly allows to change after creation; discount values cannot be edited.
- Recurly v2021-02-25 is pinned with the Accept header.
- Usage records are billable-adjacent: Record usage is marked billable and never retried automatically.
- Coupon redemptions, related invoices, business entities, invoice templates and entitlements document no limit parameter, so those lists page with Recurly's default size; coupon redemptions sort by updated_at without an explicit order.
- Payouts and settlements: Recurly is a billing platform and does not pay out funds, so its API has no payout or settlement list. Payouts, settlement lines and processor fees come from the payment gateway (for example Stripe, Adyen or Braintree), which is connected separately.
- Processor fees: Recurly transactions carry no gateway fee amounts; read fees from the payment gateway connected separately.
- Disputes: Recurly's API has no dispute object. Chargebacks show as transactions with status chargeback, but the transaction list cannot filter by status, so read all transactions since the last run and filter on status in the flow. Dispute details (reason, evidence, deadlines) come from the payment gateway connected separately.
- Refunds are read with the transactions list filtered to type refund; refunds of account credit are in credit payments (action refund).
- Billing info and payment methods, gift cards, purchases, pending line items, subscription changes (create), coupon redemption create, unique code generation, dunning campaigns, external subscriptions and invoice PDFs are not offered. General ledger accounts and shipping methods are read only.
Developer reference
- Create the Recurly credentials described above with the narrowest permissions your flows need.
- In Nexra, open Connect, then Connections, then New connection, choose Recurly, enter its settings and credentials, and tick only the write actions you need. Connection guide
- Test the connection, then use its actions as flow sources and destinations. Flow guide
Machine-readable detail: GET /api/public/connect/connectors/recurly and the Connections API.
