Connectors

Recurly

Manage Recurly billing — accounts, billing info, subscriptions, invoices, line items, transactions, coupons, catalog (items/plans/add-ons), usage, and revenue ledger — via the v3 API. Covers Basic auth, region base URLs, the version header, code- ids, and the nested list envelope.

On this page

Connecting Recurly How Recurly actions are structured Reading the response Accounts Billing Info Subscriptions Invoices & Line Items Transactions & Credit Payments Coupons & Redemptions Catalog: Items, Plans, Add-ons Usage, Shipping, Notes, Custom Fields Revenue / General Ledger Generic Request Step Name Step Reference Execution Settings Caching Locking

Connecting Recurly

Every action needs a Recurly connection configured with HTTP Basic authentication — your Recurly Private API key as the username, empty password.

Base URL — every action offers a Base URL dropdown: https://v3.recurly.com (US) or https://v3.eu.recurly.com (EU). Pick the one for your site.
API version — Recurly requires Accept = application/vnd.recurly.v2021-02-25 (the version this connector's spec targets). If it isn't offered as a field on an action, add it via Additional Headers.

How Recurly actions are structured

Each action is one Recurly v3 operation. In the picker they're grouped by the spec's tags — account, billing_info, subscription, invoice, line_item, transaction, coupon, coupon_redemption, credit_payment, item, plan, add-on, shipping_address, note, usage, external_*, gift_cards, general_ledger_account, dunning_campaigns, and more (plus Generic Request).

Recurly resources are addressed by id or by a code- prefix: e.g. a subscription's path parameter subscription_id accepts either the UUID or code-<your-code>; an account's account_id accepts the UUID or code-<account-code>. Many operations are "nested" — e.g. an account's subscriptions at /accounts/{account_id}/subscriptions and the whole-site list at /subscriptions.

Reading the response

Every action's result is at {{<stepReference>.response...}} (see Step Reference): {{<stepReference>.response.status}}, {{<stepReference>.response.headers.<name>}}, and {{<stepReference>.response.data...}} for the body.

A single resource — fields are directly under data, e.g. {{get_subscription.response.data.id}}, {{get_subscription.response.data.state}}, {{get_subscription.response.data.total}}, plus {{<stepReference>.response.data.object}} naming the type.
A list — {{<stepReference>.response.data.data}} is the array (note the doubled .data), with {{<stepReference>.response.data.has_more}} and {{<stepReference>.response.data.next}} (a relative URL). Page forward by calling Generic Request with that next path, or set list query parameters (limit up to 200, order, sort, begin_time, end_time, state, ids) via Additional Query Parameters.

A non-2xx response does not fail the step — Recurly's error body ({{<stepReference>.response.data.error.type}}, {{<stepReference>.response.data.error.message}}, {{<stepReference>.response.data.error.params}}) is returned with the real status. A 422 is a validation error; a 429 means back off.

Accounts

GET /accounts (list), POST /accounts (create), GET /accounts/{account_id} (fetch). Create/update body: code (your account code), email, first_name, last_name, company, billing_info, address, preferred_locale.
Related reads: /balance, /acquisition, /entitlements, /external_invoices, /external_subscriptions, /accounts (child accounts), /notes, /shipping_addresses.

Billing Info

GET /accounts/{account_id}/billing_info — the account's primary billing info.
GET|POST /accounts/{account_id}/billing_infos and GET /accounts/{account_id}/billing_infos/{billing_info_id} — the multiple-payment-method list. Create body: a tokenized token_id from Recurly.js, or raw card fields (PCI scope permitting), or external_hpp_type / gateway fields.

Subscriptions

GET /subscriptions (site) / GET /accounts/{account_id}/subscriptions (account), POST /subscriptions (create), GET /subscriptions/{subscription_id} (fetch).
Create body: plan_code, account ({ "code": "..." } or nested new account), currency, unit_amount, quantity, add_ons, coupon_codes, custom_fields, starts_at.
Also /preview_renewal (a preview of the next renewal invoice(s)), plus the subscription's /invoices, /line_items, /coupon_redemptions.

Invoices & Line Items

Invoices — GET /invoices (site) / GET /accounts/{account_id}/invoices (account), GET /invoices/{invoice_id}, GET /invoices/{invoice_id}.pdf (PDF body), POST /accounts/{account_id}/invoices (collect pending line items into an invoice), /related_invoices, /coupon_redemptions.
Line items — GET /line_items (site), GET /accounts/{account_id}/line_items / POST /accounts/{account_id}/line_items (add a one-off charge or credit — body: currency, unit_amount, quantity, type = charge/credit, revenue_schedule_type), GET /line_items/{line_item_id}.

Transactions & Credit Payments

Transactions — GET /transactions (site) / GET /accounts/{account_id}/transactions (account), GET /transactions/{transaction_id}. Read-only; refunds are done via invoice endpoints (use Generic Request).
Credit payments — GET /credit_payments / GET /accounts/{account_id}/credit_payments, GET /credit_payments/{credit_payment_id}.

Coupons & Redemptions

Coupons — GET|POST /coupons, GET /coupons/{coupon_id}. Create body: code, name, discount_type (percent/fixed/free_trial), discount_percent or currencies, redemption_resource, applies_to_all_plans, duration.
Unique coupon codes (bulk coupons) — GET /coupons/{coupon_id}/unique_coupon_codes, GET /unique_coupon_codes/{unique_coupon_code_id}.
Coupon redemptions — GET /accounts/{account_id}/coupon_redemptions (all / /active), POST /accounts/{account_id}/coupon_redemptions/active (apply a coupon to an account/subscription — body: coupon_code, currency, subscription_id), plus invoice- and subscription-scoped reads.

Catalog: Items, Plans, Add-ons

Items — GET|POST /items, GET|PUT /items/{item_id}, plus deactivate/reactivate (via Generic Request).
Plans — GET|POST /plans, GET|PUT|DELETE /plans/{plan_id}.
Add-ons — GET|POST /plans/{plan_id}/add_ons, GET|PUT|DELETE /plans/{plan_id}/add_ons/{add_on_id}, plus site-wide /add_ons.

Usage, Shipping, Notes, Custom Fields

Usage — GET|POST /subscriptions/{subscription_id}/line_items/{line_item_id}/usage and reads.
Shipping addresses — GET|POST /accounts/{account_id}/shipping_addresses, GET|PUT|DELETE /accounts/{account_id}/shipping_addresses/{shipping_address_id}.
Notes — GET|POST /accounts/{account_id}/notes, GET /accounts/{account_id}/notes/{account_note_id}.
Custom field definitions — GET /custom_field_definitions, GET /custom_field_definitions/{custom_field_definition_id} (read-only).

Revenue / General Ledger

General ledger accounts — GET|POST /general_ledger_accounts, GET /general_ledger_accounts/{general_ledger_account_id}.
Performance obligations — GET /performance_obligations, GET /performance_obligations/{performance_obligation_id} (read-only).

Generic Request

Five actions — Generic GET / POST / PUT / PATCH / DELETE Request — for the many operations not surfaced as dedicated actions (subscription changes/pause/resume/cancel, invoice refunds and mark-paid, purchases, exports, dunning campaigns, business entities, gift cards, measured units, external products/subscriptions, and following a list's next URL).

path — required, relative to the Base URL, e.g. /subscriptions/<id>/change, /invoices/<id>/refund, /purchases, or the next value from a list response.
Add the Accept version header here too.

Also applies here

Step Name

What it's for

Every step in a workflow gets a name — either one you set or a default based on the connector and action (e.g. "Get Order Details", "Send Welcome Email"). It's shown throughout the UI and in your execution history, and it's also the source for the step's Reference — a camelCase identifier auto-generated from the name (e.g. "Get Order Details" → getOrderDetails) — which is what you actually use in {{...}} expressions to read this step's output from later steps. See Step Reference.

Rules

Must be at least 2 characters, and 50 characters or fewer.
Must be unique within the workflow — reusing a name that's already taken will be rejected, with a suggested alternative (e.g. "Get Order Details 2").
Can't be empty.

Tips

Prefer a descriptive, human-readable name over a generic one — "Get Order Details" is easier to work with later than "HTTP Request 2", especially once a workflow has a dozen steps.
Renaming a step updates every reference to it elsewhere in the workflow automatically.

Step Reference

Syntax

Any input field can reference earlier data using {{expression}}. The expression is evaluated as JSONata — so simple dot-paths and more advanced queries (filters, functions) both work.

Referencing a step's output

Use the step's Reference — a camelCase identifier auto-generated from its Name (e.g. "Get Order Details" → getOrderDetails), shown read-only wherever the step's fields are configured — followed by the field path. Elsewhere in these docs this general pattern is written as {{<stepReference>.field.path}}:

{{getOrderDetails.response.data.id}}
{{getOrderDetails.response.status}}

The raw display name won't work here even though it's what you see in the UI — {{Get Order Details.response.data.id}} isn't valid, since a bare name containing spaces isn't a single JSONata identifier. Always use the camelCase Reference.

You can also reference steps by position instead of by reference:

{{steps[0].response.data.id}}

Referencing trigger data

{{trigger.headers.authorization}}
{{trigger.body.customerId}}
{{trigger.query.page}}
{{trigger.params.orderId}}
{{trigger.method}}
{{trigger.path}}

Referencing workflow variables

{{variables.myVariable}}

See Variables for the full list of variable types and more examples, including connection-type variables.

Referencing runtime variables

A separate, mutable namespace written by the Variable connector while a run is in progress — not the same as the workflow-level variables above:

{{runtimeVariables.myVariable}}

Notes

If an expression can't be resolved (a typo in a step name, a field that doesn't exist), it resolves to an empty string rather than failing the workflow — check your execution history if a value comes through blank.
Object values are automatically JSON-stringified when interpolated into a string field.

Execution Settings

Fire-and-forget

When enabled, the workflow doesn't wait for this step to complete before moving to the next one. Use it for steps whose result nothing downstream depends on — logging, analytics, notifications — so they don't add latency to the steps that matter.

Continue on error

When enabled, a failure in this step doesn't stop the workflow — execution continues to the next step. The failure is still recorded in the execution history; this just controls whether it's fatal.

Combine the two for steps that are genuinely optional to the outcome: fire-and-forget so they don't add latency, continue-on-error so a failure in them (e.g. an analytics endpoint being briefly down) doesn't take down an otherwise-successful workflow run.

Caching

What it does

When enabled, a step's result is cached for a configurable TTL (time-to-live, in seconds). If the step runs again with the same effective cache key before the TTL expires, the cached result is returned instead of re-running the step.

Configuring it

Enabled — turn caching on or off for this step.
TTL — how long (in seconds) a cached result stays valid.
Cache key template — an expression (supporting the same {{...}} step reference syntax used elsewhere) that determines what counts as "the same call". By default this is based on the step's resolved input; a custom template lets you cache more narrowly or broadly than that.

When to use it

Good candidates are steps that call something slow or rate-limited but return the same answer for the same input within a short window — a lookup against a rarely-changing external system, for example. Skip it for steps whose result must always be fresh (anything involving live inventory, pricing, or payment state).

Locking

What it does

When enabled, only one execution of this step (for a given lock key) can run at a time. If a second execution tries to run the same step while a lock is held, it waits until the lock is released or the hold period elapses.

Configuring it

Enabled — turn locking on or off for this step.
Lock key — an expression (supporting the same {{...}} step reference syntax used elsewhere) that determines what counts as "the same resource". By default the lock is scoped to the step itself; a custom key lets you lock per-customer, per-order, or any other identifier that needs serialized access.
Period — how long (in seconds) the lock is held before it's automatically released, in case an execution doesn't complete normally.

When to use it

Use it whenever concurrent executions could race on the same resource — e.g. two workflow runs both trying to update the same order's status at once. A lock key scoped to the order id ensures only one of them proceeds at a time.