# Recurly MCP connector

The Recurly connector lets Claude, ChatGPT, Cursor and other AI clients look up and update Recurly accounts, subscriptions, items, credit payments and ledger records, with each person signed in as themselves and every action recorded.

Source: https://elaichi.ai/connectors/recurly/

## Facts

| | |
| --- | --- |
| Application | Recurly |
| Category | Subscription Platform |
| AI tools | 197 |
| Authentication | Connects with an API key |
| Needs your own OAuth app | No |
| MCP endpoint | https://api.elaichi.ai/mcp |
| Works with | Claude, ChatGPT, Cursor, any MCP client, and the Elaichi Agent |
| Tools advertised by name | No. 197 tools is past the 30-tool threshold, so clients use `search_tools` and `execute_tool` |

## What you can ask once Recurly is connected

- List Recurly accounts with subscriptions renewing this month.
- Show credit payments issued on the EMEA Recurly site.
- Summarize acquisitions by channel across all Recurly sites.

## Connect Recurly in Elaichi

This happens once for the organization, before any client is involved.

1. Open Connections, choose Add connection, and pick Recurly.
2. Optionally set Share with, then press Connect.
3. Paste a Recurly API key. One person generates a token in Recurly and pastes it once. Everyone else works through Share with, and never sees it.

Credentials are vaulted and nobody, including the AI, reads them back. The connection becomes a toolbox immediately, so you can curate which Recurly tools are exposed, rename them, or freeze arguments before anyone points a client at it.

## Connect Recurly to Claude

Endpoint: https://api.elaichi.ai/mcp

1. Open Customize, then Connectors.
2. Press Add.
3. Name it, paste the MCP server URL, then Continue.
4. Sign in and approve.

On Team and Enterprise, an Owner adds it once. Everyone else turns it on for themselves.

## Connect Recurly to ChatGPT

Endpoint: https://api.elaichi.ai/mcp

1. Open Plugins, then press the + button.
2. Name it and paste the endpoint into Server URL.
3. Leave Authentication on OAuth, then tick the risk acknowledgement.
4. Press Create, then sign in and approve.

Works on the web today. The plugin directory lives at chatgpt.com/plugins.

## Connect Recurly to Cursor

Endpoint: https://api.elaichi.ai/mcp

1. Open `~/.cursor/mcp.json`.
2. Add the endpoint under `mcpServers`.
3. Reload Cursor, then sign in and approve.

Set up per machine, so repeat it on each computer you work from.

## Connect Recurly to any MCP client

Endpoint: https://api.elaichi.ai/mcp

1. Add the endpoint as a remote MCP server.
2. Sign in and approve.

The Elaichi Agent already has these tools, with nothing to set up.

## What the consent screen decides

Only Read is granted by default, which is not enough to call a Recurly tool. Over MCP there is no trusted place to confirm a write in the moment, so the consent screen is the standing approval rather than a formality. Grant Read and Run tools. Think hard before granting Delete, which reaches into connected apps and cannot be undone.

## What teams do with Recurly through Elaichi

### Pull up an account while the customer waits

Support. Ask for a customer's Recurly account and see their subscriptions, billing details and any child accounts in one answer, without leaving the conversation.

### Catch the account up after a call

Customer success. Update the billing contact, company name or custom fields on a Recurly account as soon as the call ends, so the record matches what was agreed.

### Set up a new customer the day they sign

Sales. Create the Recurly account for a closed deal and check which existing accounts sit under the same parent before the first invoice goes out.

### Review credit payments before month end

Finance. List recent credit payments across Recurly, open the ones that look unusual and get a plain summary of what was applied to which account.

### Keep revenue recognition mapped correctly

Accounting. List general ledger accounts and performance obligations in Recurly, add a new ledger account when the chart of accounts changes, and confirm everything is mapped.

### Maintain the item catalog in Recurly

Billing operations. Add a new item, correct a description or price detail on an existing one, and list what is already in the catalog before a plan change.

## Frequently asked questions

### How do I connect Recurly to Claude?

In Elaichi, choose Recurly and paste in your Recurly API key, then in Claude go to Customize, then Connectors, then Add and paste the endpoint https://api.elaichi.ai/mcp. There is no OAuth application to register in Recurly and no client ID or secret to generate. Once both steps are done, Claude can work with your Recurly accounts, subscriptions and items.

### Does Recurly work with ChatGPT and Cursor as well as Claude?

Yes. Once Recurly is connected in Elaichi, the same endpoint, https://api.elaichi.ai/mcp, works in Claude, ChatGPT, Cursor, any other MCP client and the Elaichi Agent. You connect Recurly once and every client sees it.

### What can an AI agent actually do with my Recurly data?

An agent can find a Recurly account, list its subscriptions and child accounts, create or update an account, review credit payments, and work with items, general ledger accounts and performance obligations. It can also list your Recurly sites, acquisitions and custom field definitions. Because Recurly has a large set of actions, short concrete asks such as "show the subscriptions on the Acme account" get better results than long paragraphs.

### Does connecting Recurly give the AI access to everything in my sites?

No. Every call to Recurly runs inside the access of the person who signed in, so the agent sees only the sites, accounts and records that person could already reach. Elaichi can narrow that further, for example to read-only or to a single site, but it can never widen it beyond what Recurly itself allows.

### Can my team share one Recurly connection?

Yes. One person connects Recurly in Elaichi and shares it with a team, and nobody else ever handles the Recurly API key. Each teammate still signs in to Elaichi as themselves, so the audit log names the actual person behind every account update or lookup in Recurly.

### Can I stop an agent from deleting or changing things in Recurly?

Yes. Restrictions in Elaichi work per action, so you can allow looking up Recurly accounts and subscriptions while blocking account deletion or updates to items and ledger accounts. A blocked action is never shown to Claude, ChatGPT or any other client, so no prompt can reach it.

### What happens to a Recurly connection when someone leaves?

Offboarding the person in Elaichi ends their access to Recurly through every AI client at once. If they had shared their Recurly connection with a team, it keeps working for everyone else. If you want to remove Recurly entirely, disconnecting it once in Elaichi removes it from Claude, ChatGPT, Cursor and every other client.

## All 197 Recurly tools

Every tool below is callable through https://api.elaichi.ai/mcp once Recurly is connected, subject to the toolbox it is in and the restrictions on the caller.

- **List all Recurly sites** (List). List Recurly sites, most useful for finding a site's ID for subsequent requests. Returns: id, object, subdomain, public_api_key, mode, address, settings, features, created_at, updated_at, deleted_at.
- **Get single Recurly site by ID** (Get). Get a Recurly site by id. Returns: id, object, subdomain, public_api_key, mode, address, settings, features, created_at, updated_at, deleted_at. Required: id.
- **List all Recurly accounts** (List). List a site's Recurly accounts with optional filtering by email, subscriber status, past due state, and time range. Returns: id, object, state, hosted_login_token, shipping_addresses, has_live_subscription, has_active_subscription, has_future_subscription, has_canceled_subscription, has_paused_subscription, has_past_due_invoice, created_at, updated_at, deleted_at, code, username, email,…
- **Create a Recurly account** (Create). Create a new Recurly account with optional billing info, shipping addresses, and acquisition data. Returns: id, object, state, hosted_login_token, shipping_addresses, has_live_subscription, has_active_subscription, has_future_subscription, has_canceled_subscription, has_paused_subscription, has_past_due_invoice, created_at, updated_at, deleted_at, code, username, email,…. Required: code.
- **Get single Recurly account by ID** (Get). Fetch a single Recurly account by id. Returns: id, object, state, hosted_login_token, shipping_addresses, has_live_subscription, has_active_subscription, has_future_subscription, has_canceled_subscription, has_paused_subscription, has_past_due_invoice, created_at, updated_at, deleted_at, code, username, email, override_business_entity_id, preferred_locale, preferred_time_zone, cc_emails,…. Required: id.
- **Update a Recurly account by ID** (Update). Update a Recurly account by id with modified account attributes. Returns: id, object, state, hosted_login_token, shipping_addresses, has_live_subscription, has_active_subscription, has_future_subscription, has_canceled_subscription, has_paused_subscription, has_past_due_invoice, created_at, updated_at, deleted_at, code, username, email, override_business_entity_id, preferred_locale,…. Required: id.
- **Delete a Recurly account by ID** (Delete). Deactivate a Recurly account by id. Permanently deletes the account's billing information and cancels any active subscriptions (canceled subscriptions remain active until the end of the current billing cycle). Returns: id, object, state, hosted_login_token, shipping_addresses, has_live_subscription, has_active_subscription, has_future_subscription, has_canceled_subscription,…. Required: id.
- **Recurly accounts list subscriptions** (List). List all subscriptions for a Recurly account, with optional filtering by state and date range. Returns: id, object, uuid, account, plan, state, shipping, coupon_redemptions, pending_change, current_period_started_at, current_period_ends_at, current_term_started_at, current_term_ends_at, trial_started_at, trial_ends_at, remaining_billing_cycles, total_billing_cycles, renewal_billing_cycles,…. Required: account_id.
- **Recurly accounts list child accounts** (List). List child accounts associated with a Recurly account, with optional filtering by email, subscriber status, and past due status. Returns: id, object, state, hosted_login_token, shipping_addresses, has_live_subscription, has_active_subscription, has_future_subscription, has_canceled_subscription, has_paused_subscription, has_past_due_invoice, created_at, updated_at, deleted_at, code, username,…. Required: account_id.
- **List all Recurly acquisitions** (List). List a site's account acquisition data in Recurly. Returns: cost, channel, subchannel, campaign, acquired_at, id, object, account, created_at, updated_at. Supports filtering by ids, begin_time, and end_time, and sorting by date fields with configurable order.
- **List all Recurly credit payments** (List). List a site's credit payments in Recurly, optionally filtered by date range and sorted by date fields. Returns each credit payment with: object, id, uuid, created_at, updated_at.
- **Get single Recurly credit payment by ID** (Get). Get a single credit payment in Recurly by id. Returns: id, object, uuid, action, account, applied_to_invoice, original_invoice, currency, amount, original_credit_payment_id, refund_transaction, created_at, updated_at, voided_at. Required: id.
- **List all Recurly custom field definitions** (List). List custom field definitions for a Recurly site, optionally filtered by related type. Returns: id, object, related_type, name, user_access, display_name, tooltip, created_at, updated_at, deleted_at.
- **Get single Recurly custom field definition by ID** (Get). Get a single Recurly custom field definition by id. Returns: id, object, related_type, name, user_access, display_name, tooltip, created_at, updated_at, deleted_at. Required: id.
- **List all Recurly general ledger accounts** (List). List a site's general ledger accounts in Recurly. Returns: id, object, code, description, account_type, created_at, updated_at. Filter by specific IDs or account type, and sort results.
- **Create a Recurly general ledger account** (Create). Create a new general ledger account in Recurly. Returns: id, object, code, description, account_type, created_at, updated_at.
- **Get single Recurly general ledger account by ID** (Get). Get a single Recurly general ledger account by id. Returns: id, object, code, description, account_type, created_at, updated_at. Required: id.
- **Update a Recurly general ledger account by ID** (Update). Update a general ledger account in Recurly by id. Returns: id, object, code, description, account_type, created_at, updated_at. Required: id.
- **List all Recurly performance obligations** (List). List a site's Performance Obligations in Recurly. Returns: id, name, created_at, updated_at.
- **Get single Recurly performance obligation by ID** (Get). Get a single Recurly Performance Obligation by id. Returns: id, name, created_at, updated_at. Required: id.
- **List all Recurly items** (List). List a site's Recurly items with optional filtering by IDs, state, and date range. Returns: id, object, code, state, name, description, external_sku, accounting_code, revenue_schedule_type, performance_obligation_id, liability_gl_account_id, revenue_gl_account_id, avalara_transaction_type, avalara_service_type, tax_code, harmonized_system_code, tax_exempt, custom_fields, currencies, created_at,…
- **Create a Recurly item** (Create). Create a new Recurly item. Returns: id, object, code, state, name, description, external_sku, accounting_code, revenue_schedule_type, performance_obligation_id, liability_gl_account_id, revenue_gl_account_id, avalara_transaction_type, avalara_service_type, tax_code, harmonized_system_code, tax_exempt, custom_fields, currencies, created_at, updated_at, deleted_at. Required: code, name.
- **Get single Recurly item by ID** (Get). Fetch a single Recurly item by id. Returns: id, object, code, state, name, description, external_sku, accounting_code, revenue_schedule_type, performance_obligation_id, liability_gl_account_id, revenue_gl_account_id, avalara_transaction_type, avalara_service_type, tax_code, harmonized_system_code, tax_exempt, custom_fields, currencies, created_at, updated_at, deleted_at. Required: id.
- **Update a Recurly item by ID** (Update). Update an active Recurly item by id. Returns: id, object, code, state, name, description, external_sku, accounting_code, revenue_schedule_type, performance_obligation_id, liability_gl_account_id, revenue_gl_account_id, avalara_transaction_type, avalara_service_type, tax_code, harmonized_system_code, tax_exempt, custom_fields, currencies, created_at, updated_at, deleted_at. Required: id.
- **Delete a Recurly item by ID** (Delete). Deactivate a Recurly item by id, making it unavailable for new purchases without affecting existing line items. Returns: id, object, code, state, name, description, external_sku, accounting_code, revenue_schedule_type, performance_obligation_id, liability_gl_account_id, revenue_gl_account_id, avalara_transaction_type, avalara_service_type, tax_code, harmonized_system_code, tax_exempt,…. Required: id.
- **List all Recurly measured units** (List). List a site's measured units in Recurly. Returns: id, object, name, display_name, state, description, created_at, updated_at, deleted_at. Supports filtering by ids, state, and date range with sort order control.
- **Create a Recurly measured unit** (Create). Create a new measured unit in Recurly. Returns the created measured unit object including id, object, created_at, updated_at, and deleted_at. Required: name, display_name.
- **Get single Recurly measured unit by ID** (Get). Fetch a single measured unit by id in Recurly. Returns: id, object, name, display_name, state, description, created_at, updated_at, deleted_at. Required: id.
- **Update a Recurly measured unit by ID** (Update). Update a measured unit in Recurly by id. Returns the updated measured unit object including id, object, created_at, updated_at, and deleted_at. Required: id.
- **Delete a Recurly measured unit by ID** (Delete). Delete a measured unit in Recurly by id. Returns the measured unit object including id, object, created_at, updated_at, and deleted_at. A measured unit cannot be deleted if it is used by an active plan. Required: id.
- **List all Recurly external products** (List). List a site's external products in Recurly, sorted by date. Returns: id, object, name, plan, created_at, updated_at, external_product_references.
- **Create a Recurly external product** (Create). Create an external product in Recurly. Returns the created external product including its id, object, created_at, and updated_at. Required: name.
- **Get single Recurly external product by ID** (Get). Fetch a single external product in Recurly by id. Returns: id, object, name, plan, created_at, updated_at, external_product_references. Required: id.
- **Update a Recurly external product by ID** (Update). Update an external product in Recurly by id. Returns the updated external product including id, object, created_at, and updated_at. Required: id, plan_id.
- **Delete a Recurly external product by ID** (Delete). Deactivate an external product in Recurly by id. Returns the deactivated external product including id, object, created_at, and updated_at. Required: id.
- **List all Recurly plans** (List). List a site's plans in Recurly. Returns: id, object, code, name, state, pricing_model, currencies, ramp_intervals, setup_fees, interval_unit, interval_length, description, accounting_code, revenue_schedule_type, liability_gl_account_id, revenue_gl_account_id, performance_obligation_id, setup_fee_accounting_code, setup_fee_revenue_schedule_type, setup_fee_liability_gl_account_id,…
- **Create a Recurly plan** (Create). Create a new plan in Recurly. Returns: id, object, code, name, state, pricing_model, currencies, ramp_intervals, setup_fees, interval_unit, interval_length, description, accounting_code, revenue_schedule_type, liability_gl_account_id, revenue_gl_account_id, performance_obligation_id, setup_fee_accounting_code, setup_fee_revenue_schedule_type, setup_fee_liability_gl_account_id,…
- **Get single Recurly plan by ID** (Get). Fetch a single plan in Recurly by id. Returns: id, object, code, name, state, pricing_model, currencies, ramp_intervals, setup_fees, interval_unit, interval_length, description, accounting_code, revenue_schedule_type, liability_gl_account_id, revenue_gl_account_id, performance_obligation_id, setup_fee_accounting_code, setup_fee_revenue_schedule_type, setup_fee_liability_gl_account_id,…. Required: id.
- **Update a Recurly plan by ID** (Update). Update a plan in Recurly by id. Returns: id, object, code, name, state, pricing_model, currencies, ramp_intervals, setup_fees, interval_unit, interval_length, description, accounting_code, revenue_schedule_type, liability_gl_account_id, revenue_gl_account_id, performance_obligation_id, setup_fee_accounting_code, setup_fee_revenue_schedule_type, setup_fee_liability_gl_account_id,…. Required: id.
- **Delete a Recurly plan by ID** (Delete). Remove a plan in Recurly by id. Returns: id, object, code, name, state, pricing_model, currencies, ramp_intervals, setup_fees, interval_unit, interval_length, description, accounting_code, revenue_schedule_type, liability_gl_account_id, revenue_gl_account_id, performance_obligation_id, setup_fee_accounting_code, setup_fee_revenue_schedule_type, setup_fee_liability_gl_account_id,…. Required: id.
- **List all Recurly plan add ons** (List). List a plan's add-ons in Recurly. Returns: id, object, plan_id, code, state, name, add_on_type, usage_type, usage_calculation_type, usage_percentage, measured_unit_id, liability_gl_account_id, revenue_gl_account_id, performance_obligation_id, accounting_code, revenue_schedule_type, avalara_transaction_type, avalara_service_type, tax_code, harmonized_system_code, display_quantity,…. Required: plan_id.
- **Create a Recurly plan add on** (Create). Create a new add-on for a plan in Recurly. Returns: id, object, plan_id, code, state, name, add_on_type, usage_type, usage_calculation_type, usage_percentage, measured_unit_id, liability_gl_account_id, revenue_gl_account_id, performance_obligation_id, accounting_code, revenue_schedule_type, avalara_transaction_type, avalara_service_type, tax_code, harmonized_system_code, display_quantity,…. Required: plan_id, code, name.
- **Get single Recurly plan add on by ID** (Get). Fetch a single plan add-on by id in Recurly. Returns: id, object, plan_id, code, state, name, add_on_type, usage_type, usage_calculation_type, usage_percentage, measured_unit_id, liability_gl_account_id, revenue_gl_account_id, performance_obligation_id, accounting_code, revenue_schedule_type, avalara_transaction_type, avalara_service_type, tax_code, harmonized_system_code, display_quantity,…. Required: id, plan_id.
- **Update a Recurly plan add on by ID** (Update). Update a plan add-on in Recurly. Returns: id, object, plan_id, code, state, name, add_on_type, usage_type, usage_calculation_type, usage_percentage, measured_unit_id, liability_gl_account_id, revenue_gl_account_id, performance_obligation_id, accounting_code, revenue_schedule_type, avalara_transaction_type, avalara_service_type, tax_code, harmonized_system_code, display_quantity, default_quantity,…. Required: id, plan_id.
- **Delete a Recurly plan add on by ID** (Delete). Remove a plan add-on from Recurly. Returns the deleted add-on including id, code, and name. Required: id, plan_id.
- **List all Recurly subscriptions** (List). List a site's subscriptions in Recurly, filterable by IDs, state, and date range. Returns: id, object, uuid, account, plan, state, shipping, coupon_redemptions, pending_change, current_period_started_at, current_period_ends_at, current_term_started_at, current_term_ends_at, trial_started_at, trial_ends_at, remaining_billing_cycles, total_billing_cycles, renewal_billing_cycles, auto_renew,…
- **Create a Recurly subscription** (Create). Create a new subscription in Recurly with a plan, currency, and account. Returns: id, object, uuid, account, plan, state, shipping, coupon_redemptions, pending_change, current_period_started_at, current_period_ends_at, current_term_started_at, current_term_ends_at, trial_started_at, trial_ends_at, remaining_billing_cycles, total_billing_cycles, renewal_billing_cycles, auto_renew, ramp_intervals,…. Required: plan_code, account, currency.
- **Get single Recurly subscription by ID** (Get). Fetch a single Recurly subscription by id. Returns: id, object, uuid, account, plan, state, shipping, coupon_redemptions, pending_change, current_period_started_at, current_period_ends_at, current_term_started_at, current_term_ends_at, trial_started_at, trial_ends_at, remaining_billing_cycles, total_billing_cycles, renewal_billing_cycles, auto_renew, ramp_intervals, paused_at,…. Required: id.
- **Update a Recurly subscription by ID** (Update). Update a Recurly subscription's non-billing settings such as terms and customer notes. Use the Subscription Change endpoint for plan or billing-impacting changes. Returns: id, object, uuid, account, plan, state, shipping, coupon_redemptions, pending_change, current_period_started_at, current_period_ends_at, current_term_started_at, current_term_ends_at, trial_started_at, trial_ends_at,…. Required: id.
- **Delete a Recurly subscription by ID** (Delete). Terminate a Recurly subscription by id, immediately expiring it with an optional refund (full, partial, or none). Returns: id, object, uuid, account, plan, state, shipping, coupon_redemptions, pending_change, current_period_started_at, current_period_ends_at, current_term_started_at, current_term_ends_at, trial_started_at, trial_ends_at, remaining_billing_cycles, total_billing_cycles,…. Required: id.
- **Recurly subscriptions cancel** (Cancel). Cancel a Recurly subscription by subscription_id. The subscription continues through the current billing cycle before expiring at the end of the cycle; future subscriptions become failed and cannot be reactivated. Returns: id, object, uuid, account, plan, state, shipping, coupon_redemptions, pending_change, current_period_started_at, current_period_ends_at, current_term_started_at,…. Required: subscription_id.
- **Recurly subscriptions pause** (Pause). Pause a Recurly subscription at the next renewal by subscription_id. Setting remaining_pause_cycles to 0 on a currently paused subscription resumes it. Expired, cancelled, or failed subscriptions cannot be paused. Returns: id, object, uuid, account, plan, state, shipping, coupon_redemptions, pending_change, current_period_started_at, current_period_ends_at, current_term_started_at,…. Required: subscription_id, remaining_pause_cycles.
- **Recurly subscriptions resume** (Resume). Resume a paused Recurly subscription and immediately move it into the active state. Returns: id, object, uuid, account, plan, state, shipping, coupon_redemptions, pending_change, current_period_started_at, current_period_ends_at, current_term_started_at, current_term_ends_at, trial_started_at, trial_ends_at, remaining_billing_cycles, total_billing_cycles, renewal_billing_cycles, auto_renew,…. Required: subscription_id.
- **List all Recurly invoices** (List). List a site's invoices in Recurly with optional filtering by state, type, and date range. Returns: id, uuid, object, type, origin, state, account, billing_info_id, subscription_ids, previous_invoice_id, number, collection_method, po_number, net_terms, net_terms_type, address, shipping_address, currency, discount, coupon_redemptions, subtotal, subtotal_after_discount, tax,…
- **Get single Recurly invoice by ID** (Get). Get a single Recurly invoice by id. Returns: id, uuid, object, type, origin, state, account, billing_info_id, subscription_ids, previous_invoice_id, number, collection_method, po_number, net_terms, net_terms_type, address, shipping_address, currency, discount, coupon_redemptions, subtotal, subtotal_after_discount, tax, reference_only_currency_conversion, total, refundable_amount, paid, balance,…. Required: id.
- **Update a Recurly invoice by ID** (Update). Update a Recurly invoice's customer notes and terms. Returns: id, uuid, object, type, origin, state, account, billing_info_id, subscription_ids, previous_invoice_id, number, collection_method, po_number, net_terms, net_terms_type, address, shipping_address, currency, discount, coupon_redemptions, subtotal, subtotal_after_discount, tax, reference_only_currency_conversion, total, refundable_amount,…. Required: id.
- **Recurly invoices get PDF** (Get). Download a Recurly invoice as a PDF file. Returns: data.
- **List all Recurly transactions** (List). List a site's transactions in Recurly with optional filtering by IDs, date range, transaction type, and success status. Returns: id, object, uuid, original_transaction_id, account, initiator, invoice, merchant_reason_code, voided_by_invoice, subscription_ids, type, origin, currency, description, amount, status, success, backup_payment_method_used, refunded, billing_address, collection_method,…
- **Get single Recurly transaction by ID** (Get). Get a single Recurly transaction by id. Returns: id, object, uuid, original_transaction_id, account, initiator, invoice, merchant_reason_code, voided_by_invoice, subscription_ids, type, origin, currency, description, amount, status, success, backup_payment_method_used, refunded, billing_address, collection_method, payment_method, ip_address_v4, ip_address_country, status_code, status_message,…. Required: id.
- **List all Recurly line items** (List). List a site's line items in Recurly with optional filtering by state, type, original line item, and date range. Returns: id, object, uuid, type, item_code, item_id, external_sku, revenue_schedule_type, state, legacy_category, account, bill_for_account_id, subscription_id, plan_id, plan_code, add_on_id, add_on_code, invoice_id, invoice_number, previous_line_item_id, original_line_item_invoice_id,…
- **Get single Recurly line item by ID** (Get). Get a single line item in Recurly by id. Returns: id, object, uuid, type, item_code, item_id, external_sku, revenue_schedule_type, state, legacy_category, account, bill_for_account_id, subscription_id, plan_id, plan_code, add_on_id, add_on_code, invoice_id, invoice_number, previous_line_item_id, original_line_item_invoice_id, origin, accounting_code, product_code, credit_reason_code, currency,…. Required: id.
- **Delete a Recurly line item by ID** (Delete). Delete an uninvoiced Recurly line item by id. Returns an empty 204 response on success. Only pending (uninvoiced) line items can be deleted; attempting to delete an already-invoiced item results in a 422 error. Required: id.
- **List all Recurly add ons** (List). List a site's add-ons in Recurly with optional filtering by IDs, state, and date range. Returns: id, object, plan_id, code, state, name, add_on_type, usage_type, usage_calculation_type, usage_percentage, measured_unit_id, liability_gl_account_id, revenue_gl_account_id, performance_obligation_id, accounting_code, revenue_schedule_type, avalara_transaction_type, avalara_service_type, tax_code,…
- **Get single Recurly add on by ID** (Get). Get a single add-on in Recurly by id. Returns: id, object, plan_id, code, state, name, add_on_type, usage_type, usage_calculation_type, usage_percentage, measured_unit_id, liability_gl_account_id, revenue_gl_account_id, performance_obligation_id, accounting_code, revenue_schedule_type, avalara_transaction_type, avalara_service_type, tax_code, harmonized_system_code, display_quantity,…. Required: id.
- **List all Recurly price segments** (List). List a site's price segments in Recurly. Returns: object, id, code, created_at, updated_at. Supports filtering by specific IDs and sort order.
- **Get single Recurly price segment by ID** (Get). Fetch a single price segment in Recurly by id. Returns: object, id, code, created_at, updated_at. Required: id.
- **List all Recurly shipping methods** (List). List a site's shipping methods in Recurly. Returns: id, object, code, name, accounting_code, tax_code, liability_gl_account_id, revenue_gl_account_id, performance_obligation_id, created_at, updated_at, deleted_at. Supports filtering by ids, date range, and sorting.
- **Create a Recurly shipping method** (Create). Create a new shipping method in Recurly. Returns: id, object, code, name, accounting_code, tax_code, liability_gl_account_id, revenue_gl_account_id, performance_obligation_id, created_at, updated_at, deleted_at. Required: code, name.
- **Get single Recurly shipping method by ID** (Get). Fetch a single shipping method in Recurly by id. Returns: id, object, code, name, accounting_code, tax_code, liability_gl_account_id, revenue_gl_account_id, performance_obligation_id, created_at, updated_at, deleted_at. Required: id.
- **Update a Recurly shipping method by ID** (Update). Update an active shipping method in Recurly. Returns: id, object, code, name, accounting_code, tax_code, liability_gl_account_id, revenue_gl_account_id, performance_obligation_id, created_at, updated_at, deleted_at. Required: id.
- **Delete a Recurly shipping method by ID** (Delete). Deactivate a Recurly shipping method by id, making it unavailable for new subscriptions or purchases without affecting existing ones. Returns: id, object, code, name, accounting_code, tax_code, liability_gl_account_id, revenue_gl_account_id, performance_obligation_id, created_at, updated_at, deleted_at. Required: id.
- **List all Recurly coupons** (List). List a site's coupons in Recurly. Returns: id, object, code, name, state, max_redemptions, max_redemptions_per_account, unique_coupon_codes_count, unique_code_template, unique_coupon_code, duration, temporal_amount, temporal_unit, free_trial_unit, free_trial_amount, applies_to_all_plans, applies_to_all_items, applies_to_non_plan_charges, plans, items, redemption_resource, discount, coupon_type,…
- **Create a Recurly coupon** (Create). Create a new coupon in Recurly. Returns: id, object, code, name, state, max_redemptions, max_redemptions_per_account, unique_coupon_codes_count, unique_code_template, unique_coupon_code, duration, temporal_amount, temporal_unit, free_trial_unit, free_trial_amount, applies_to_all_plans, applies_to_all_items, applies_to_non_plan_charges, plans, items, redemption_resource, discount, coupon_type,…. Required: name, code, discount_type.
- **Get single Recurly coupon by ID** (Get). Get a single Recurly coupon by id. Returns: id, object, code, name, state, max_redemptions, max_redemptions_per_account, unique_coupon_codes_count, unique_code_template, unique_coupon_code, duration, temporal_amount, temporal_unit, free_trial_unit, free_trial_amount, applies_to_all_plans, applies_to_all_items, applies_to_non_plan_charges, plans, items, redemption_resource, discount, coupon_type,…. Required: id.
- **Update a Recurly coupon by ID** (Update). Update an active Recurly coupon by id. Returns: id, object, code, name, state, max_redemptions, max_redemptions_per_account, unique_coupon_codes_count, unique_code_template, unique_coupon_code, duration, temporal_amount, temporal_unit, free_trial_unit, free_trial_amount, applies_to_all_plans, applies_to_all_items, applies_to_non_plan_charges, plans, items, redemption_resource, discount,…. Required: id.
- **Delete a Recurly coupon by ID** (Delete). Expire a Recurly coupon by id, marking it as expired. Returns the expired coupon including id, code, name, and discount_type. Required: id.
- **Recurly coupons restore** (Restore). Restore an inactive coupon. Returns: id, object, code, name, state, max_redemptions, max_redemptions_per_account, unique_coupon_codes_count. Required: coupon_id.
- **Get single Recurly unique coupon code by ID** (Get). Fetch a unique coupon code in Recurly by id. Returns: id, object, code, state, bulk_coupon_id, bulk_coupon_code, created_at, updated_at, redeemed_at, expired_at, status. Required: id.
- **Delete a Recurly unique coupon code by ID** (Delete). Deactivate a unique coupon code in Recurly by id, making that specific code no longer redeemable without affecting the parent bulk coupon. Returns: id, object, code, state, bulk_coupon_id, bulk_coupon_code, created_at, updated_at, redeemed_at, expired_at, status. Required: id.
- **Recurly unique coupon codes restore** (Restore). Restore a previously deactivated unique coupon code in Recurly, making it redeemable again. Returns: id, object, code, state, bulk_coupon_id, bulk_coupon_code, created_at, updated_at, redeemed_at, expired_at, status. Required: unique_coupon_code_id.
- **List all Recurly account acquisitions** (List). Fetch an account's acquisition data in Recurly. Returns: id, campaign, channel, subchannel, cost, created_at, updated_at. Required: account_id.
- **Recurly account acquisitions bulk update** (Update). Update an account's acquisition data in Recurly. Returns the updated acquisition object including id, campaign, channel, subchannel, and cost. Required: account_id.
- **Recurly account acquisitions bulk delete** (Delete). Remove an account's acquisition data in Recurly. Returns an empty 204 response on success. Required: account_id.
- **List all Recurly account balances** (List). Fetch an account's balance and past due status in Recurly. Returns: object, account, past_due, balances. Required: account_id.
- **Recurly account redacts redact** (Action). Redact an account (GDPR Right to Erasure). Returns: id, object, state, hosted_login_token, shipping_addresses, has_live_subscription, has_active_subscription, has_future_subscription. Required: account_id.
- **Recurly account reactivates reactivate** (Reactivate). Reactivate an inactive account. Returns: id, object, state, hosted_login_token, shipping_addresses, has_live_subscription, has_active_subscription, has_future_subscription. Required: account_id.
- **List all Recurly account credit payments** (List). List credit payments for a specific Recurly account. Returns: id, object, uuid, action, account, applied_to_invoice, original_invoice, currency, amount, original_credit_payment_id, refund_transaction, created_at, updated_at, voided_at. Required: account_id.
- **List all Recurly account external accounts** (List). List external accounts for a Recurly account. Returns: object, id, external_account_code, external_connection_type, created_at, updated_at. Required: account_id.
- **Create a Recurly account external account** (Create). Create an external account for a Recurly account. Returns the created external account object including id, object, created_at, and updated_at. Required: account_id, external_account_code, external_connection_type.
- **Get single Recurly account external account by ID** (Get). Get a single external account for a Recurly account by id. Returns: object, id, external_account_code, external_connection_type, created_at, updated_at. Required: id, account_id.
- **Update a Recurly account external account by ID** (Update). Update an external account in Recurly. Returns the updated external account object including id, object, created_at, and updated_at. Required: id, account_id.
- **Delete a Recurly account external account by ID** (Delete). Delete an external account from a Recurly account. Returns the deleted external account object including id, object, created_at, and updated_at. Required: id, account_id.
- **List all Recurly account external invoices** (List). List the external invoices on an account. Returns: id, object, account, external_subscription, external_id, state, total, currency. Required: account_id.
- **List all Recurly account invoices** (List). List an account's invoices in Recurly. Returns: id, uuid, object, type, origin, state, account, billing_info_id, subscription_ids, previous_invoice_id, number, collection_method, po_number, net_terms, net_terms_type, address, shipping_address, currency, discount, coupon_redemptions, subtotal, subtotal_after_discount, tax, reference_only_currency_conversion, total, refundable_amount, paid,…. Required: account_id.
- **Create a Recurly account invoice** (Create). Create an invoice for pending line items on a Recurly account. Returns: object, charge_invoice, credit_invoices, verification_transactions. Required: account_id, currency.
- **Recurly invoices previews preview** (Action). Preview a new Recurly invoice for an account's pending line items without persisting it. Returns: object, charge_invoice, credit_invoices, verification_transactions. Required: account_id, currency.
- **List all Recurly account line items** (List). List Recurly line items for an account. Returns: id, object, uuid, type, item_code, item_id, external_sku, revenue_schedule_type, state, legacy_category, account, bill_for_account_id, subscription_id, plan_id, plan_code, add_on_id, add_on_code, invoice_id, invoice_number, previous_line_item_id, original_line_item_invoice_id, origin, accounting_code, product_code, credit_reason_code, currency,…. Required: account_id.
- **Create a Recurly account line item** (Create). Create a new Recurly line item (charge or credit) on an account. Returns: id, object, uuid, type, item_code, item_id, external_sku, revenue_schedule_type, state, legacy_category, account, bill_for_account_id, subscription_id, plan_id, plan_code, add_on_id, add_on_code, invoice_id, invoice_number, previous_line_item_id, original_line_item_invoice_id, origin, accounting_code, product_code,…. Required: account_id, currency, unit_amount, type.
- **List all Recurly account notes** (List). List an account's notes in Recurly. Returns: id, object, account_id, user, message, created_at. Required: account_id.
- **Create a Recurly account note** (Create). Create a note on a Recurly account. Returns the created account note including id, object, message, and created_at. Required: account_id, message.
- **Get single Recurly account note by ID** (Get). Fetch a single Recurly account note by id. Returns: id, object, account_id, user, message, created_at. Required: id, account_id.
- **Delete a Recurly account note by ID** (Delete). Delete a Recurly account note by id. Returns an empty 204 response on success. Required: id, account_id.
- **List all Recurly account shipping addresses** (List). List an account's shipping addresses in Recurly, with optional filtering by ids and date range. Returns: id, object, account_id, nickname, first_name, last_name, company, email, vat_number, phone, street1, street2, city, region, postal_code, country, geo_code, created_at, updated_at. Required: account_id.
- **Create a Recurly account shipping address** (Create). Create a new shipping address for a Recurly account. Returns: id, object, account_id, nickname, first_name, last_name, company, email, vat_number, phone, street1, street2, city, region, postal_code, country, geo_code, created_at, updated_at. Required: account_id, first_name, last_name, street1, city, postal_code, country.
- **Get single Recurly account shipping address by ID** (Get). Get a single Recurly account shipping address by id. Returns: id, object, account_id, nickname, first_name, last_name, company, email, vat_number, phone, street1, street2, city, region, postal_code, country, geo_code, created_at, updated_at. Required: id, account_id.
- **Update a Recurly account shipping address by ID** (Update). Update a Recurly account shipping address by id. Returns: id, object, account_id, nickname, first_name, last_name, company, email, vat_number, phone, street1, street2, city, region, postal_code, country, geo_code, created_at, updated_at. Required: id, account_id.
- **Delete a Recurly account shipping address by ID** (Delete). Remove a Recurly account shipping address by id. Returns an empty 204 response on success. Required: id, account_id.
- **List all Recurly account transactions** (List). List an account's transactions in Recurly with optional filtering by transaction type, success status, and date range. Returns: id, object, uuid, original_transaction_id, account, initiator, invoice, merchant_reason_code, voided_by_invoice, subscription_ids, type, origin, currency, description, amount, status, success, backup_payment_method_used, refunded, billing_address, collection_method,…. Required: account_id.
- **List all Recurly account entitlements** (List). List entitlements granted to a Recurly account. Returns: object, customer_permission, granted_by, created_at, updated_at. Required: account_id.
- **List all Recurly account external subscriptions** (List). List all external subscriptions belonging to a Recurly account. Returns each external subscription's id, object, created_at, and updated_at. Required: account_id.
- **List all Recurly account coupon redemptions** (List). List coupon redemptions for a Recurly account. Returns: id, object, uuid, account, subscription_id, coupon, state, remaining_duration, currency, discounted, created_at, updated_at, removed_at. Required: account_id.
- **Get single Recurly account coupon redemption by ID** (Get). Get a single coupon redemption for a Recurly account by id. Returns: id, object, uuid, account, subscription_id, coupon, state, remaining_duration, currency, discounted, created_at, updated_at, removed_at. Required: id, account_id.
- **Delete a Recurly account coupon redemption by ID** (Delete). Delete (deactivate) a coupon redemption from a Recurly account. Returns the deleted coupon redemption object including id, state, created_at, and updated_at. Returns 422 if the redemption is already expired or inactive. Required: id, account_id.
- **List all Recurly coupon redemptions actives** (List). List active coupon redemptions on a Recurly account. Returns: id, object, uuid, account, subscription_id, coupon, state, remaining_duration, currency, discounted, created_at, updated_at, removed_at, redeemed_at. Required: account_id.
- **Create a Recurly coupon redemptions active** (Create). Generate an active coupon redemption on a Recurly account or subscription. Returns the created coupon redemption including its id. Required: account_id, coupon_id.
- **Recurly coupon redemptions actives bulk delete** (Delete). Delete the active coupon redemption from a Recurly account. Returns the deleted coupon redemption including its id. Required: account_id.
- **List all Recurly account billing infos** (List). List billing information records associated with a Recurly account. Returns: id, object, account_id, first_name, last_name, company, address, vat_number, valid, payment_method, fraud, primary_payment_method, backup_payment_method, payment_gateway_references, created_at, updated_at, updated_by. Required: account_id.
- **Create a Recurly account billing info** (Create). Add new billing information to a Recurly account, supporting credit card, external tokenized, or Recurly.js token submissions. Returns: id, object, account_id, first_name, last_name, company, address, vat_number, valid, payment_method, fraud, primary_payment_method, backup_payment_method, payment_gateway_references, created_at, updated_at, updated_by. When using token_id,…. Required: account_id.
- **Get single Recurly account billing info by ID** (Get). Get a single billing information record from a Recurly account by id. Returns: id, object, account_id, first_name, last_name, company, address, vat_number, valid, payment_method, fraud, primary_payment_method, backup_payment_method, payment_gateway_references, created_at, updated_at, updated_by. Required: id, account_id.
- **Update a Recurly account billing info by ID** (Update). Update a Recurly account's billing information by id, supporting credit card, external tokenized, or Recurly.js token submissions. Returns: id, object, account_id, first_name, last_name, company, address, vat_number, valid, payment_method, fraud, primary_payment_method, backup_payment_method, payment_gateway_references, created_at, updated_at, updated_by. When using…. Required: id, account_id.
- **Delete a Recurly account billing info by ID** (Delete). Delete a Recurly account's billing information by id. Returns an empty 204 response on success. If the account has an active subscription, the renewal will go into dunning unless billing info is updated before renewal. Required: id, account_id.
- **Recurly account billing infos verify** (Verify). Verify a billing information's credit card in Recurly by running a verification transaction on the specified billing info. Returns transaction information including id, created_at, and updated_at. Required: account_id, billing_info_id.
- **Recurly account billing infos get primary** (Get). Fetch an account's primary billing information in Recurly. Returns: id, object, account_id, first_name, last_name, company, address, vat_number, valid, payment_method, fraud, primary_payment_method, backup_payment_method, payment_gateway_references, created_at, updated_at, updated_by. Required: account_id.
- **Recurly account billing infos delete primary** (Delete). Remove an account's primary billing information in Recurly. If the account has a subscription, the renewal will go into dunning unless billing info is updated before renewal. Returns an empty 204 response on success. Required: account_id.
- **Recurly account billing infos bulk update** (Update). Set an account's primary billing information in Recurly. Supports credit card payments (first_name, last_name, number, month, year), Recurly.js tokens (token_id with only primary_payment_method or backup_payment_method permitted), and external tokenized payments (gateway_token, gateway_code). Returns: id, object, account_id, first_name, last_name, company, address, vat_number, valid,…. Required: account_id.
- **Recurly billing info verifies verify** (Verify). Verify an account's credit card billing information in Recurly by running a verification transaction against the stored billing info. Returns a Transaction object including its id, status, and created_at. Required: account_id.
- **Recurly billing info verify cvvs verify** (Verify). Verify an account's credit card CVV in Recurly. Returns a transaction object including id, type, status, amount_in_cents, currency, and created_at. A credit card can only be checked 3 times in 24 hours. Required: account_id.
- **Recurly billing info verify cvvs verify billing info** (Verify). Verify a specific billing information's credit card CVV in Recurly. Returns a transaction object including id, type, status, amount_in_cents, currency, and created_at. Required: account_id, billing_info_id.
- **Create a Recurly coupon generate** (Create). Generate unique coupon codes for a bulk coupon in Recurly. Returns a set of parameters that can be passed to the list_unique_coupon_codes endpoint to retrieve only the newly generated unique coupon codes. Required: coupon_id.
- **Create a Recurly coupon generate sync** (Create). Generate up to 200 unique coupon codes synchronously for a bulk Recurly coupon, returned directly in the response. Returns the generated unique coupon codes with object, has_more, next, and data fields. For larger batches, use the asynchronous generate endpoint instead. Required: coupon_id, number_of_unique_codes.
- **List all Recurly coupon unique coupon codes** (List). List unique coupon codes associated with a bulk coupon in Recurly. Returns: id, object, code, state, bulk_coupon_id, bulk_coupon_code, created_at, updated_at, redeemed_at, expired_at. Required: coupon_id.
- **Recurly item reactivates reactivate** (Reactivate). Reactivate an inactive item in Recurly, making it available for new purchases without affecting existing line items. Returns: id, object, code, state, name, description, external_sku, accounting_code, revenue_schedule_type, performance_obligation_id, liability_gl_account_id, revenue_gl_account_id, avalara_transaction_type, avalara_service_type, tax_code, harmonized_system_code, tax_exempt,…. Required: item_id.
- **List all Recurly external product external product references** (List). List external product references for an external product in Recurly. Returns: id, object, reference_code, external_connection_type, created_at, updated_at. Required: external_product_id.
- **Create a Recurly external product external product reference** (Create). Create an external product reference on an external product in Recurly. Returns: id, object, reference_code, external_connection_type, created_at, updated_at. Required: external_product_id.
- **Get external product external product reference by ID** (Get). Fetch an external product reference by id in Recurly. Returns: id, object, reference_code, external_connection_type, created_at, updated_at. Required: id, external_product_id.
- **Delete external product external product reference by ID** (Delete). Deactivate an external product reference in Recurly. Returns: id, object, reference_code, external_connection_type, created_at, updated_at. Required: id, external_product_id.
- **List all Recurly external subscriptions** (List). List external subscriptions on a Recurly site. Returns: id, object, account, external_product_reference, external_payment_phases, external_id, uuid, last_purchased, auto_renew, in_grace_period, app_identifier, quantity, state, activated_at, canceled_at, expires_at, trial_started_at, trial_ends_at, test, imported, created_at, updated_at. Supports sorting by a date field.
- **Create a Recurly external subscription** (Create). Create an external subscription in Recurly. Returns: id, object, account, external_product_reference, external_payment_phases, external_id, uuid, last_purchased, auto_renew, in_grace_period, app_identifier, quantity, state, activated_at, canceled_at, expires_at, trial_started_at, trial_ends_at, test, imported, created_at, updated_at. A request body conforming to the ExternalSubscriptionCreate…
- **Get single Recurly external subscription by ID** (Get). Fetch a single external subscription in Recurly by id. Returns: id, object, account, external_product_reference, external_payment_phases, external_id, uuid, last_purchased, auto_renew, in_grace_period, app_identifier, quantity, state, activated_at, canceled_at, expires_at, trial_started_at, trial_ends_at, test, imported, created_at, updated_at. Required: id.
- **Update a Recurly external subscription by ID** (Update). Update an external subscription in Recurly by id. Returns: id, object, account, external_product_reference, external_payment_phases, external_id, uuid, last_purchased, auto_renew, in_grace_period, app_identifier, quantity, state, activated_at, canceled_at, expires_at, trial_started_at, trial_ends_at, test, imported, created_at, updated_at. An optional request body conforming to the…. Required: id.
- **List all Recurly external subscription external invoices** (List). List the external invoices on an external subscription in Recurly. Returns: id, object, account, external_subscription, external_id, state, total, currency, line_items, purchased_at, created_at, updated_at. Required: external_subscription_id.
- **Create a Recurly external subscription external invoice** (Create). Create an external invoice for an external subscription in Recurly. Returns the created external invoice including its id, created_at, and updated_at. A JSON request body is required. Required: external_subscription_id, external_id, state, total, currency, purchased_at.
- **List all Recurly external subscription external payment phases** (List). List external payment phases on an external subscription in Recurly. Returns: id, object, started_at, ends_at, starting_billing_period_index, ending_billing_period_index, offer_type, offer_name, period_count, period_length, amount, currency, created_at, updated_at. Required: external_subscription_id.
- **Get external subscription external payment phase by ID** (Get). Fetch a single external payment phase from a Recurly external subscription. Returns: id, object, started_at, ends_at, starting_billing_period_index, ending_billing_period_index, offer_type, offer_name, period_count, period_length, amount, currency, created_at, updated_at. Required: id, external_subscription_id.
- **Recurly invoice apply credit balances apply credit balance** (Action). Apply available credit from an account's credit invoices to the outstanding balance of a pending or past due charge invoice in Recurly. Returns the updated invoice including its id and number. Returns a 422 error if the invoice is legacy or closed, or if the account has no available credit. Required: invoice_id.
- **Recurly invoice collects collect** (Action). Force a collection attempt on a pending or past due automatic Recurly invoice using stored billing information, triggering a transaction outside the normal retry logic. Returns the updated invoice including id, number, state, currency, total, and balance. Only works on automatic invoices that are pending or past due; manual or closed invoices return an error. Required: invoice_id.
- **Recurly invoice mark faileds mark failed** (Action). Mark an open invoice as failed in Recurly, halting collection attempts and dunning procedures. Returns the updated invoice including id, number, and state. Only invoices in the pending, processing, or past_due states can be marked as failed. Required: invoice_id.
- **Recurly invoice mark successfuls mark successful** (Action). Mark an open Recurly invoice as successful, indicating payment was received via another method and that automated collection attempts should stop. Returns the updated invoice including its id, number, and state. Only invoices in the pending, processing, past_due, or failed states can be marked as successful. Required: invoice_id.
- **Recurly invoice reopens reopen** (Action). Reopen a closed, manual invoice in Recurly. Returns the updated invoice including id, number, and state. Only applicable to manual invoices currently in a successful or failed state. Required: invoice_id.
- **Recurly invoice voids void** (Action). Void a credit invoice in Recurly. Returns the updated invoice including its id, state, and type. The invoice must be a credit invoice (type=credit) and cannot be closed, processing, or already voided. Required: invoice_id.
- **Recurly invoice transactions record transaction** (Action). Record an external (offline) payment for a manual invoice in Recurly. Returns the recorded transaction with its id, amount, currency, status, type, payment_method, and created_at. Throws an error for auto-collecting invoices. Required: invoice_id.
- **List all Recurly invoice line items** (List). List all line items belonging to a specific Recurly invoice. Returns: id, object, uuid, type, item_code, item_id, external_sku, revenue_schedule_type, state, legacy_category, account, bill_for_account_id, subscription_id, plan_id, plan_code, add_on_id, add_on_code, invoice_id, invoice_number, previous_line_item_id, original_line_item_invoice_id, origin, accounting_code, product_code,…. Required: invoice_id.
- **List all Recurly invoice coupon redemptions** (List). List the coupon redemptions applied to a Recurly invoice. Returns: id, object, uuid, account, subscription_id, coupon, state, remaining_duration, currency, discounted, created_at, updated_at, removed_at. Required: invoice_id.
- **List all Recurly invoice related invoices** (List). List an invoice's related credit or charge invoices. Returns: id, uuid, object, type, origin, state, account, billing_info_id. Required: invoice_id.
- **Recurly invoice refunds refund** (Action). Refund a Recurly invoice by a specific amount, percentage, or by targeting individual line items. Returns the new credit invoice including id, number, and created_at. Percentage and line-item-specific dollar/percentage refunds require the Credit Memos feature flag; omitting amount with type=amount refunds the entire refundable balance. Required: invoice_id, type.
- **Create a Recurly invoices recovery** (Create). Create an invoice for revenue recovery in Recurly. Returns the new invoices as an InvoiceCollection. A JSON request body conforming to the RecoveryInvoiceCreate schema is required. A 422 error is returned for invalid parameters, no pending line items, or transaction errors. Required: currency, due_at, external_recovery_eligible, account, line_items.
- **Recurly subscription reactivates reactivate** (Reactivate). Reactivate a canceled Recurly subscription, bringing it back to an active, renewing state on the customer's original billing cycle. Returns the reactivated subscription object including its id, uuid, and state. Expired or failed subscriptions cannot be reactivated; a new subscription plan must be applied instead. Required: subscription_id.
- **Recurly subscription convert trials convert trial** (Convert). Convert trial subscription. Returns: id, object, uuid, account, plan, state, shipping, coupon_redemptions. Required: subscription_id.
- **List all Recurly subscription preview renewals** (List). Preview a Recurly subscription's upcoming renewal invoice(s). Returns: object, charge_invoice, credit_invoices, verification_transactions. Returns an empty result with no invoices if the subscription is not set to renew. Required: subscription_id.
- **List all Recurly subscription changes** (List). Fetch a subscription's pending change in Recurly. Returns: id, object, subscription_id, plan, add_ons, unit_amount, tax_inclusive, quantity, shipping, activate_at, activated, revenue_schedule_type, invoice_collection, business_entity, custom_fields, created_at, updated_at, deleted_at, billing_info, ramp_intervals, next_bill_date. Required: subscription_id.
- **Create a Recurly subscription change** (Create). Create a new subscription change in Recurly, overwriting any existing pending change. Returns: id, object, created_at, updated_at. Submitting a change that matches the current subscription reverts the pending change and returns a 204 response. Required: subscription_id.
- **Recurly subscription changes bulk delete** (Delete). Delete a pending subscription change in Recurly, causing current subscription settings to apply on the next renewal. Returns an empty 204 response on success. Activated subscription changes cannot be deleted. Required: subscription_id.
- **Recurly change previews preview** (Action). Preview a subscription change in Recurly without saving it or overwriting an existing pending change. Returns the previewed subscription change object including id, state, plan, quantity, and activation_time. Required: subscription_id.
- **List all Recurly subscription invoices** (List). List a Recurly subscription's invoices with optional filtering by state, type, date range, and sorting. Returns: id, uuid, object, type, origin, state, account, billing_info_id, subscription_ids, previous_invoice_id, number, collection_method, po_number, net_terms, net_terms_type, address, shipping_address, currency, discount, coupon_redemptions, subtotal, subtotal_after_discount, tax,…. Required: subscription_id.
- **List all Recurly subscription line items** (List). List a subscription's line items in Recurly. Returns: id, object, uuid, type, item_code, item_id, external_sku, revenue_schedule_type, state, legacy_category, account, bill_for_account_id, subscription_id, plan_id, plan_code, add_on_id, add_on_code, invoice_id, invoice_number, previous_line_item_id, original_line_item_invoice_id, origin, accounting_code, product_code, credit_reason_code,…. Required: subscription_id.
- **List all Recurly subscription coupon redemptions** (List). List coupon redemptions for a Recurly subscription, optionally filtered by IDs and date range. Returns: id, object, uuid, account, subscription_id, coupon, state, remaining_duration, currency, discounted, created_at, updated_at, removed_at. Required: subscription_id.
- **Get single Recurly subscription coupon redemption by ID** (Get). Get a single coupon redemption for a Recurly subscription by id. Returns: id, object, uuid, account, subscription_id, coupon, state, remaining_duration, currency, discounted, created_at, updated_at, removed_at. Required: id, subscription_id.
- **Delete a Recurly subscription coupon redemption by ID** (Delete). Delete the coupon redemption from a subscription. Returns: id, object, uuid, account, subscription_id, coupon, state, remaining_duration. Required: id, subscription_id.
- **List all Recurly add on usages** (List). List usage records for a subscription add-on in Recurly. Returns: id, object, merchant_tag, amount, usage_type, tier_type, tiers, percentage_tiers, measured_unit_id, recording_timestamp, usage_timestamp, usage_percentage, unit_amount, unit_amount_decimal, billed_at, created_at, updated_at. Required: subscription_id, add_on_id.
- **Create a Recurly add on usage** (Create). Log a usage record on a Recurly subscription add-on. Returns: id, object, merchant_tag, amount, usage_type, tier_type, tiers, percentage_tiers, measured_unit_id, recording_timestamp, usage_timestamp, usage_percentage, unit_amount, unit_amount_decimal, billed_at, created_at, updated_at, merkeltag, usage_at, recording_at, closing_at, measured_unit, subscription, add_on. Required: subscription_id, add_on_id.
- **Get single Recurly usage by ID** (Get). Get a Recurly usage record by id. Returns: id, object, merchant_tag, amount, usage_type, tier_type, tiers, percentage_tiers, measured_unit_id, recording_timestamp, usage_timestamp, usage_percentage, unit_amount, unit_amount_decimal, billed_at, created_at, updated_at. Required: id.
- **Update a Recurly usage by ID** (Update). Update a Recurly usage record by id. Returns: id, object, merchant_tag, amount, usage_type, tier_type, tiers, percentage_tiers, measured_unit_id, recording_timestamp, usage_timestamp, usage_percentage, unit_amount, unit_amount_decimal, billed_at, created_at, updated_at. Required: id.
- **Delete a Recurly usage by ID** (Delete). Delete a Recurly usage record by id. Returns an empty 204 response on success. Required: id.
- **Create a Recurly purchase** (Create). Create a new purchase in Recurly containing one or more subscriptions or one-time charges on a single invoice, paid with one transaction. Returns: object, charge_invoice, credit_invoices, verification_transactions. Required: currency, account.
- **Recurly purchases cancel** (Cancel). Cancel an open authorization purchase request in Recurly. Returns: object, charge_invoice, credit_invoices, verification_transactions. Required: transaction_id.
- **Create a Recurly purchases preview** (Create). Preview a new Recurly purchase without committing it. A purchase is a checkout containing subscriptions or one-time charges with coupon and gift card redemptions. Returns: object, charge_invoice, credit_invoices, verification_transactions. Required: currency, account.
- **Create a Recurly purchases pending** (Create). Create a pending purchase in Recurly for Adyen HPP and Online Banking transaction requests. Runs validations but not the transactions. Returns the invoice collection including charge_invoice with id and uuid. An email address is required on the account for a Pending Purchase. Required: currency, account.
- **Create a Recurly purchases authorize** (Create). Authorize a purchase. Returns: object, charge_invoice, credit_invoices, verification_transactions. Required: currency, account.
- **Create a Recurly purchase capture** (Create). Capture an open authorization request for a Recurly purchase by transaction id. Returns the captured invoice collection with object, charge_invoice, and credit_invoices. Required: transaction_id.
- **List all Recurly export dates** (List). List the dates that have available Recurly automated exports ready for download. Returns: dates. No required parameters.
- **List all Recurly export date export files** (List). List Recurly export files available for download on a given export date. Returns: href, md5sum. Required: export_date.
- **List all Recurly dunning campaigns** (List). List dunning campaigns configured for a Recurly site. Returns: id, object, code, name, description, default_campaign, dunning_cycles, created_at, updated_at, deleted_at.
- **Get single Recurly dunning campaign by ID** (Get). Fetch a dunning campaign in Recurly by id. Returns: id, object, code, name, description, default_campaign, dunning_cycles, created_at, updated_at, deleted_at. Required: id.
- **Recurly dunning campaign bulk updates bulk update** (Update). Assign a Recurly dunning campaign to multiple plans in a single bulk update request. Returns: object, plans. Required: dunning_campaign_id.
- **List all Recurly invoice templates** (List). List invoice templates for a Recurly site. Returns: id, code, name, description, created_at, updated_at. The sort parameter controls which date field results are ordered by.
- **Get single Recurly invoice template by ID** (Get). Get a single Recurly invoice template by id. Returns: id, code, name, description, created_at, updated_at. Required: id.
- **List all Recurly invoice template accounts** (List). List accounts associated with a specific invoice template in Recurly. Returns each account's id and code. Required: invoice_template_id.
- **List all Recurly external invoices** (List). List the external invoices on a Recurly site. Returns: id, object, account, external_subscription, external_id, state, total, currency, line_items, purchased_at, created_at, updated_at.
- **Get single Recurly external invoice by ID** (Get). Get a single Recurly external invoice by id. Returns: id, object, account, external_subscription, external_id, state, total, currency, line_items, purchased_at, created_at, updated_at. Required: id.
- **List all Recurly business entities** (List). List all business entities on a Recurly site. Returns: id, object, code, name, invoice_display_address, tax_address, origin_tax_address_source, destination_tax_address_source, default_vat_number, default_registration_number, subscriber_location_countries, default_liability_gl_account_id, default_revenue_gl_account_id, created_at, updated_at.
- **Get single Recurly business entity by ID** (Get). Get a single Recurly business entity by id. Returns: id, object, code, name, invoice_display_address, tax_address, origin_tax_address_source, destination_tax_address_source, default_vat_number, default_registration_number, subscriber_location_countries, default_liability_gl_account_id, default_revenue_gl_account_id, created_at, updated_at. Required: id.
- **List all Recurly business entitie invoices** (List). List a business entity's invoices. Returns: id, uuid, object, type, origin, state, account, billing_info_id. Required: business_entity_id.
- **List all Recurly gift cards** (List). List all gift cards created on your Recurly site. Returns: id, object, gifter_account_id, recipient_account_id, purchase_invoice_id, redemption_invoice_id, redemption_code, balance, product_code, unit_amount, currency, delivery, performance_obligation_id, liability_gl_account_id, revenue_gl_account_id, created_at, updated_at, delivered_at, redeemed_at, canceled_at.
- **Create a Recurly gift card** (Create). Create a new gift card in Recurly. Returns: id, object, gifter_account_id, recipient_account_id, purchase_invoice_id, redemption_invoice_id, redemption_code, balance, product_code, unit_amount, currency, delivery, performance_obligation_id, liability_gl_account_id, revenue_gl_account_id, created_at, updated_at, delivered_at, redeemed_at, canceled_at. Requires a gift card creation request body. Required: product_code, unit_amount, currency, delivery, gifter_account.
- **Get single Recurly gift card by ID** (Get). Get a Recurly gift card by id. Returns: id, object, gifter_account_id, recipient_account_id, purchase_invoice_id, redemption_invoice_id, redemption_code, balance, product_code, unit_amount, currency, delivery, performance_obligation_id, liability_gl_account_id, revenue_gl_account_id, created_at, updated_at, delivered_at, redeemed_at, canceled_at. Required: id.
- **Create a Recurly gift cards preview** (Create). Preview a gift card in Recurly before creating it. Returns the gift card object including its id and gift card-specific attributes. Requires a gift card creation request body conforming to the GiftCardCreate schema. Required: product_code, unit_amount, currency, delivery, gifter_account.
- **Create a Recurly gift card redeem** (Create). Redeem a Recurly gift card by its redemption code. Returns the redeemed gift card object including its id, created_at, and updated_at. Required: redemption_code, recipient_account.
