--- title: Recurly API Integration on Truto slug: recurly category: Subscription Platform canonical: "https://truto.one/integrations/detail/recurly/" --- # Recurly API Integration on Truto **Category:** Subscription Platform **Status:** Generally available ## MCP-ready AI tools Truto exposes 197 tools for Recurly that AI agents can call directly. - **list_all_recurly_sites** — 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 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 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 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** — 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 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** — 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 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 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 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 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 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 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 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 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 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 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 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 a site's Performance Obligations in Recurly. Returns: id, name, created_at, updated_at. - **get_single_recurly_performance_obligation_by_id** — Get a single Recurly Performance Obligation by id. Returns: id, name, created_at, updated_at. Required: id. - **list_all_recurly_items** — 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 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** — 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 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** — 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 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 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** — 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 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 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 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 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** — 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 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** — 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 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 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** — 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 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** — 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 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 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** — 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 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** — 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 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 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** — 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 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** — 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 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 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 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 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 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 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** — Download a Recurly invoice as a PDF file. Returns: data. - **list_all_recurly_transactions** — 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 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 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 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 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 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 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 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** — 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 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 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** — 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 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** — 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 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 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 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 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** — 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 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** — 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** — 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 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** — 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 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** — Remove an account's acquisition data in Recurly. Returns an empty 204 response on success. Required: account_id. - **list_all_recurly_account_balances** — Fetch an account's balance and past due status in Recurly. Returns: object, account, past_due, balances. Required: account_id. - **recurly_account_redacts_redact** — 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 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 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 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 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 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 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 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 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 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 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** — 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 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 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 an account's notes in Recurly. Returns: id, object, account_id, user, message, created_at. Required: account_id. - **create_a_recurly_account_note** — 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** — 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 a Recurly account note by id. Returns an empty 204 response on success. Required: id, account_id. - **list_all_recurly_account_shipping_addresses** — 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 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 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 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** — 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 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 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 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 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 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 (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 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** — 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 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 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** — 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 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 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 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 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** — 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** — 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** — 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 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 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 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** — 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** — 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 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 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 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 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** — 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** — 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 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 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** — 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 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 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 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 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** — 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** — 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** — 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** — 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** — 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** — 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** — 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** — 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 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 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 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** — 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 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 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 trial subscription. Returns: id, object, uuid, account, plan, state, shipping, coupon_redemptions. Required: subscription_id. - **list_all_recurly_subscription_preview_renewals** — 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** — 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 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 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** — 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 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 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 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 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 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 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** — 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 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 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 a Recurly usage record by id. Returns an empty 204 response on success. Required: id. - **create_a_recurly_purchase** — 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 an open authorization purchase request in Recurly. Returns: object, charge_invoice, credit_invoices, verification_transactions. Required: transaction_id. - **create_a_recurly_purchases_preview** — 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 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** — Authorize a purchase. Returns: object, charge_invoice, credit_invoices, verification_transactions. Required: currency, account. - **create_a_recurly_purchase_capture** — 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 the dates that have available Recurly automated exports ready for download. Returns: dates. No required parameters. - **list_all_recurly_export_date_export_files** — List Recurly export files available for download on a given export date. Returns: href, md5sum. Required: export_date. - **list_all_recurly_dunning_campaigns** — 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** — 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** — 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 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 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 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 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 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 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 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 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 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 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 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** — 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** — 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. ## How it works 1. **Link your customer's Recurly account.** Use Truto's frontend SDK; we handle every OAuth and API key flow so you don't need to create the OAuth app. 2. **Authentication is automatic.** Truto refreshes tokens, stores credentials securely, and injects them into every API request. 3. **Call Truto's API to reach Recurly.** The Proxy API is a 1-to-1 mapping of the Recurly API. 4. **Get a unified response format.** Every response uses a single shape, with cursor-based pagination and data in the `result` field. ## Use cases - **Embed subscription context into your CRM or CS platform** — Pull Recurly accounts, subscriptions, and invoices so sales and success teams see billing state, renewal dates, and past-due status alongside customer records. Push subscription changes back when reps close upsells or CSMs process downgrades. - **Power in-app billing actions from helpdesk tools** — Let support agents cancel, pause, resume, or refund subscriptions directly from a ticket view without switching to the Recurly dashboard. Reduces resolution time and eliminates the need to grant Recurly seats to every agent. - **Ingest usage data for metered billing** — Product analytics, infrastructure, and API management tools can push add-on usage records into Recurly as end users consume resources. Ensures accurate invoicing without your customers building a custom Recurly pipeline. - **Feed MRR analytics and revenue forecasting tools** — Sync transactions, invoices, subscription changes, and pending changes into analytics products so finance teams can forecast expansion, contraction, and churn. Includes external subscriptions from App Store and Google Play flowing through Recurly. - **Automate partner and affiliate payouts** — Marketing and partner platforms can pull coupon redemptions and account acquisitions to attribute conversions and calculate commission payouts against unique coupon codes generated per campaign. ## What you can build - **Bi-directional subscription sync** — Read subscriptions and their lifecycle state, and write plan changes, cancellations, pauses, resumes, and reactivations from your product back into Recurly. - **Dunning and past-due alerting** — Monitor accounts with past-due invoices and active dunning campaigns to trigger retention workflows, CSM tasks, or in-app notifications before involuntary churn hits. - **Metered usage ingestion pipeline** — Record add-on usage against subscriptions with precise usage and recording timestamps, tied to measured units, so your customers can bill on consumption metrics captured in your product. - **Embedded invoice management** — Display invoices and line items in your UI, download invoice PDFs, and let authorized users void, reopen, mark failed/successful, apply credit balances, or issue refunds inline. - **Bulk coupon generation for campaigns** — Generate unique coupon codes in bulk from marketing tools and pull redemption data back to measure campaign performance and attribute conversions. - **External subscription visibility** — Surface App Store, Google Play, and other external subscriptions and their invoices so mobile-first customers get a unified view of web and in-app revenue. ## FAQs ### How does authentication work for end users connecting their Recurly account? Recurly uses API key authentication scoped to a specific site. Truto handles secure storage and injection of these keys per connected tenant, so your end users provide credentials once and your product calls Truto rather than managing keys directly. ### Can we support customers with multiple Recurly sites? Yes. Recurly organizes data by site, and the integration exposes list and get operations for sites so you can let end users pick which site to connect or sync data across several sites under one account. ### What subscription lifecycle actions can we trigger? You can create, update, cancel, pause, resume, reactivate, and convert trials on subscriptions. You can also preview and apply subscription changes (upgrades, downgrades, add-on modifications) before committing them. ### How do we push usage data for metered billing? Use the add-on usage endpoints to create usage records against a subscription's add-on, including the measured unit, amount, usage timestamp, and recording timestamp. Usage can also be updated or deleted before it's invoiced. ### Are custom fields on accounts and subscriptions supported? Yes. Recurly exposes custom field definitions and returns custom field values on core objects like accounts, subscriptions, and items, so your integration can round-trip customer-specific metadata. ### Can we access external subscriptions from App Store and Google Play? Yes. The integration supports listing and managing external subscriptions, external products, external invoices, and external payment phases, which is useful for mobile analytics and unified revenue reporting. ### How fresh is the data we sync from Recurly? Data is fetched on-demand via Recurly's REST API when you call Truto, so reads reflect current state. For continuous sync, you can schedule polling of list endpoints on your own cadence; Truto handles pagination and rate limit backoff. ## Related reading - [Connect Recurly to ChatGPT: Manage Subscriptions & Billing Cycles](https://truto.one/blog/connect-recurly-to-chatgpt-manage-subscriptions-billing-cycles/) — Learn how to connect Recurly to ChatGPT via a managed MCP server. Automate subscriptions, process refunds, and manage billing cycles using AI agents. - [Connect Recurly to Claude: Automate Invoices & Ledger Tracking](https://truto.one/blog/connect-recurly-to-claude-automate-invoices-ledger-tracking/) — Learn how to connect Recurly to Claude using a managed MCP server. Automate complex billing workflows, subscription management, and ledger tracking. - [Connect Recurly to AI Agents: Control Accounts & Growth Campaigns](https://truto.one/blog/connect-recurly-to-ai-agents-control-accounts-growth-campaigns/) — A complete engineering guide to connecting Recurly to AI agents. Learn how to bind Recurly tools to LLMs for autonomous subscription and billing operations.