Skip to main content
Recurly logo
  • Category: payment processing
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 10
  • Triggers: 0
  • Slug: RECURLY
  • Version: 00000000_00

Tools

Slug: RECURLY_GET_ACCOUNTFetch one Recurly customer account by opaque ID or account code. Prefix an account code with code-, for example code-customer_123; do not prefix an opaque ID.

Input Parameters

string
required
Opaque account ID, or code-<account_code> to look up by code. The code- prefix is required for account codes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECURLY_GET_ITEMFetch one Recurly catalog item by opaque ID or item code. Prefix a code with code-, for example code-red; do not prefix an opaque ID.

Input Parameters

string
required
Opaque item ID, or code-<item_code> to look up by code. The code- prefix is required for codes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECURLY_GET_PLANFetch one Recurly subscription plan by opaque ID or plan code. Prefix a code with code-, for example code-gold; do not prefix an opaque ID.

Input Parameters

string
required
Opaque plan ID, or code-<plan_code> to look up by code. The code- prefix is required for codes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECURLY_LIST_ACCOUNTSFind customer accounts on the Recurly site by email or subscription and past-due status. Returns one page and account identifiers that other tools can consume.

Input Parameters

string
Exact email address to match. Multiple accounts can share an email.
integer
Maximum accounts to return in this page (1-200).
boolean
Set true to return only accounts with a past-due invoice.
boolean
Filter by whether the account has an active, canceled, or future subscription.
string
Opaque continuation value returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECURLY_LIST_INVOICESList invoices by state or invoice type to inspect billed amounts, balances, and account or subscription references without changing invoice state.

Input Parameters

integer
Maximum invoices to return in this page (1-200).
string ("pending" | "processing" | "past_due" | "paid" | "failed" | "open" | "closed" | "voided")
Return only invoices in this state. Omit to include all states.
string
Opaque continuation value returned by the previous call. Omit for the first page and pass it back unchanged to fetch the next page.
string ("charge" | "credit" | "legacy" | "non-legacy")
Filter invoice kind. non-legacy includes charge and credit invoices.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECURLY_LIST_ITEMSList reusable catalog items on the connected Recurly site, including codes, state, tax settings, and currency pricing.

Input Parameters

integer
Maximum items to return in this page (1-200).
string ("active" | "inactive")
Return only items in this state.
string
Opaque continuation value returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECURLY_LIST_PLANSList subscription plans and their pricing configuration on the connected Recurly site.

Input Parameters

integer
Maximum plans to return in this page (1-200).
string ("active" | "inactive")
Return only plans in this state.
string
Opaque continuation value returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECURLY_LIST_SITESList Recurly sites visible to the connected private API key, including each site’s ID, subdomain, mode, currencies, and enabled features. Use this first to confirm sandbox versus production context.

Input Parameters

integer
Maximum sites to return in this page (1-200).
string ("active" | "inactive")
Return only sites in this state.
string
Opaque continuation value returned by the previous call. Omit for the first page and pass it back unchanged to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECURLY_LIST_SUBSCRIPTIONSList subscriptions and filter by lifecycle state without creating, changing, pausing, canceling, or billing a subscription.

Input Parameters

integer
Maximum subscriptions to return in this page (1-200).
string ("active" | "canceled" | "expired" | "future" | "in_trial" | "live")
Filter by lifecycle state. live includes active, canceled, future, and currently in-trial subscriptions.
string
Opaque continuation value returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECURLY_LIST_TRANSACTIONSList payment transactions by type and success status for read-only payment investigation. This tool never authorizes, captures, purchases, cancels, or refunds funds.

Input Parameters

integer
Maximum transactions to return in this page (1-200).
boolean
Set true to return only successful transactions. Omit to include all outcomes.
string
Opaque continuation value returned by the previous call. Omit for the first page and pass it back unchanged to fetch the next page.
string ("authorization" | "capture" | "payment" | "purchase" | "refund" | "verify")
Filter by transaction type; payment includes purchase and capture transactions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not