> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Recurly

> How to set up the Recurly connector, plus the actions that are available.

![Recurly](https://stackone-logos.com/api/recurly/filled/svg)

v2.0.3[See changelog](https://docs.stackone.com/connectors/recurly/changelog.md)

[139 actions](#actions) · 1 auth method

Billing

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/recurly/guides/connector-profile/api-key.md)
>
> Authenticate using your Recurly API key via HTTP Basic Auth. The API key is used as the username with an empty password.

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/recurly/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

139 actions

ActionDescription

List Accounts`recurly_list_accounts`

Retrieve a paginated list of all accounts on your Recurly site

Get Account`recurly_get_account`

Retrieve a specific account by its ID or code

Create Account`recurly_create_account`

Create a new account on your Recurly site

Update Account`recurly_update_account`

Update an existing account's details

Deactivate Account`recurly_deactivate_account`

Deactivate (soft-delete) an account

Reactivate Account`recurly_reactivate_account`

Reactivate a previously deactivated account

Get Account Balance`recurly_get_account_balance`

Fetch an account's balance and past-due status

List Subscriptions`recurly_list_subscriptions`

Retrieve a paginated list of all subscriptions on your Recurly site

List Account Subscriptions`recurly_list_account_subscriptions`

Retrieve a paginated list of subscriptions for a specific account

Get Subscription`recurly_get_subscription`

Retrieve a specific subscription by its ID

Create Subscription`recurly_create_subscription`

Create a new subscription for an account

Update Subscription`recurly_update_subscription`

Update an existing subscription's details

Cancel Subscription`recurly_cancel_subscription`

Cancel a subscription

Reactivate Subscription`recurly_reactivate_subscription`

Reactivate a canceled subscription

Pause Subscription`recurly_pause_subscription`

Pause an active subscription

Resume Subscription`recurly_resume_subscription`

Resume a paused subscription

Get Subscription Renewal Preview`recurly_get_subscription_renewal`

Fetch a preview of a subscription's renewal invoice(s)

List Subscription Invoices`recurly_list_subscription_invoices`

List a subscription's invoices

List Subscription Line Items`recurly_list_subscription_line_items`

List a subscription's line items

List Shipping Methods`recurly_list_shipping_methods`

Retrieve a paginated list of all shipping methods on your Recurly site

Create Shipping Method`recurly_create_shipping_method`

Create a new shipping method on your Recurly site

Get Shipping Method`recurly_get_shipping_method`

Fetch a specific shipping method by its ID or code

Update Shipping Method`recurly_update_shipping_method`

Update an active shipping method's details

Deactivate Shipping Method`recurly_deactivate_shipping_method`

Deactivate a shipping method making it unavailable for new subscriptions

List Coupons`recurly_list_coupons`

Retrieve a paginated list of all coupons on your Recurly site

Create Coupon`recurly_create_coupon`

Create a new coupon on your Recurly site

Get Coupon`recurly_get_coupon`

Fetch a specific coupon by its ID or code

Update Coupon`recurly_update_coupon`

Update an active coupon's details

Deactivate Coupon`recurly_deactivate_coupon`

Expire (deactivate) an active coupon

Restore Coupon`recurly_restore_coupon`

Restore an inactive (expired) coupon to active state

List Transactions`recurly_list_transactions`

Retrieve a paginated list of all transactions on your Recurly site

List Account Transactions`recurly_list_account_transactions`

Retrieve a paginated list of transactions for a specific account

Get Transaction`recurly_get_transaction`

Fetch a specific transaction by its ID or UUID

List Plans`recurly_list_plans`

Retrieve a paginated list of all plans on your Recurly site

Create Plan`recurly_create_plan`

Create a new plan on your Recurly site

Get Plan`recurly_get_plan`

Retrieve a specific plan by its ID or code

Update Plan`recurly_update_plan`

Update an existing plan's details

Remove Plan`recurly_remove_plan`

Remove (deactivate) a plan

List Items`recurly_list_items`

Retrieve a paginated list of all items on your Recurly site

Create Item`recurly_create_item`

Create a new item in your Recurly item catalog

Get Item`recurly_get_item`

Fetch a specific item by its ID or code

Update Item`recurly_update_item`

Update an active item's details

Deactivate Item`recurly_deactivate_item`

Deactivate an item making it unavailable for new purchases

Reactivate Item`recurly_reactivate_item`

Reactivate an inactive item making it available for new purchases

List Plan Add-ons`recurly_list_plan_add_ons`

Retrieve a paginated list of all add-ons for a specific plan

Create Plan Add-on`recurly_create_plan_add_on`

Create a new add-on for a specific plan

Get Plan Add-on`recurly_get_plan_add_on`

Retrieve a specific add-on for a plan by its ID or code

Update Plan Add-on`recurly_update_plan_add_on`

Update an existing add-on for a specific plan

Remove Plan Add-on`recurly_remove_plan_add_on`

Remove (deactivate) an add-on from a plan

List Credit Payments`recurly_list_credit_payments`

Retrieve a paginated list of all credit payments on your Recurly site

List Account Credit Payments`recurly_list_account_credit_payments`

Retrieve a paginated list of credit payments for a specific account

Get Credit Payment`recurly_get_credit_payment`

Fetch a specific credit payment by its ID or UUID

List Line Items`recurly_list_line_items`

Retrieve a paginated list of all line items on your Recurly site

List Account Line Items`recurly_list_account_line_items`

Retrieve a paginated list of line items for a specific account

Get Line Item`recurly_get_line_item`

Fetch a specific line item by its ID

Create Line Item`recurly_create_line_item`

Create a new line item for a specific account

Remove Line Item`recurly_remove_line_item`

Delete an uninvoiced line item

List Invoices`recurly_list_invoices`

Retrieve a paginated list of all invoices on your Recurly site

List Account Invoices`recurly_list_account_invoices`

Retrieve a paginated list of invoices for a specific account

Get Invoice`recurly_get_invoice`

Fetch a specific invoice by its ID or number

Update Invoice`recurly_update_invoice`

Update an existing invoice's details

Collect Invoice`recurly_collect_invoice`

Force a collection attempt on a pending or past due automatic invoice

Mark Invoice Failed`recurly_mark_invoice_failed`

Mark a pending, processing or past-due invoice as failed to halt dunning procedures

Mark Invoice Successful`recurly_mark_invoice_successful`

Mark a pending, processing, past-due or failed invoice as paid

Void Invoice`recurly_void_invoice`

Void a credit invoice

Create Invoice`recurly_create_invoice`

Create an invoice from an account's pending line items

Refund Invoice`recurly_refund_invoice`

Refund a charge invoice, generating a credit invoice

Reopen Invoice`recurly_reopen_invoice`

Reopen a closed or voided invoice

List Invoice Line Items`recurly_list_invoice_line_items`

Retrieve a paginated list of line items on an invoice

List Usage Records`recurly_list_usage`

Retrieve a paginated list of usage records for a subscription add-on

Create Usage Record`recurly_create_usage`

Log a usage record on a subscription add-on

Get Usage Record`recurly_get_usage`

Retrieve a specific usage record by its ID

Update Usage Record`recurly_update_usage`

Update an existing usage record by its ID

Remove Usage Record`recurly_remove_usage`

Delete a usage record by its ID

List Account Coupon Redemptions`recurly_list_account_coupon_redemptions`

List the coupon redemptions for an account

List Active Coupon Redemptions`recurly_list_active_coupon_redemptions`

List the coupon redemptions that are active on an account

Create Coupon Redemption`recurly_create_coupon_redemption`

Generate an active coupon redemption on an account or subscription

Remove Active Coupon Redemption`recurly_remove_coupon_redemption`

Delete the active coupon redemption from an account

Get Coupon Redemption`recurly_get_coupon_redemption`

Show the coupon redemption for an account

Remove Coupon Redemption By ID`recurly_remove_coupon_redemption_by_id`

Delete the coupon redemption by ID from an account

List Invoice Coupon Redemptions`recurly_list_invoice_coupon_redemptions`

List the coupon redemptions applied to an invoice

List Subscription Coupon Redemptions`recurly_list_subscription_coupon_redemptions`

List the coupon redemptions for a subscription

Get Subscription Coupon Redemption`recurly_get_subscription_coupon_redemption`

Show the coupon redemption for a subscription

Remove Subscription Coupon Redemption`recurly_remove_subscription_coupon_redemption`

Delete the coupon redemption from a subscription

Create Subscription Change`recurly_create_subscription_change`

Create a new subscription change

Get Subscription Change`recurly_get_subscription_change`

Fetch a subscription's pending change

Preview Subscription Change`recurly_preview_subscription_change`

Preview a new subscription change without saving it

Remove Subscription Change`recurly_remove_subscription_change`

Delete the pending subscription change

List Billing Infos`recurly_list_billing_infos`

List all billing information entries for an account

Create Billing Info`recurly_create_billing_info`

Add new billing information to an account

Get Billing Info`recurly_get_billing_info`

Fetch an account's billing information

Update Billing Info`recurly_update_billing_info`

Set an account's billing information

Remove Billing Info`recurly_remove_billing_info`

Remove an account's billing information

Verify Billing Info`recurly_verify_billing_info`

Verify an account's credit card billing information

Verify Billing Info CVV`recurly_verify_billing_info_cvv`

Verify an account's credit card billing CVV

Create Purchase`recurly_create_purchase`

Create a new purchase containing subscriptions or one-time charges

Preview Purchase`recurly_preview_purchase`

Preview a new purchase to see resulting invoices without creating them

Create Pending Purchase`recurly_create_pending_purchase`

Create a pending purchase for Adyen HPP and Online Banking transactions

Authorize Purchase`recurly_create_authorize_purchase`

Authorize a purchase that can be captured at a later time

Capture Purchase`recurly_create_capture_purchase`

Capture an open authorization request for a purchase

Cancel Purchase`recurly_cancel_purchase`

Cancel an open authorization request for a purchase

List Account Notes`recurly_list_account_notes`

List an account's notes

Create Account Note`recurly_create_account_note`

Create an account note

Get Account Note`recurly_get_account_note`

Fetch an account note

Remove Account Note`recurly_remove_account_note`

Delete an account note

List Shipping Addresses`recurly_list_shipping_addresses`

Fetch a list of an account's shipping addresses

Create Shipping Address`recurly_create_shipping_address`

Create a new shipping address for the account

Get Shipping Address`recurly_get_shipping_address`

Fetch an account's shipping address

Update Shipping Address`recurly_update_shipping_address`

Update an account's shipping address

Remove Shipping Address`recurly_remove_shipping_address`

Remove an account's shipping address

List Gift Cards`recurly_list_gift_cards`

Retrieve a paginated list of all gift cards on your Recurly site

Create Gift Card`recurly_create_gift_card`

Create a new gift card on your Recurly site

Get Gift Card`recurly_get_gift_card`

Fetch a specific gift card by its ID

Preview Gift Card`recurly_preview_gift_card`

Preview a gift card purchase before completing the transaction

Redeem Gift Card`recurly_redeem_gift_card`

Redeem a gift card and apply credit to a recipient account

List Measured Units`recurly_list_measured_units`

Retrieve a paginated list of all measured units on your Recurly site

Create Measured Unit`recurly_create_measured_unit`

Create a new measured unit on your Recurly site

Get Measured Unit`recurly_get_measured_unit`

Fetch a specific measured unit by its ID or name

Update Measured Unit`recurly_update_measured_unit`

Update an existing measured unit's details

Remove Measured Unit`recurly_remove_measured_unit`

Remove a measured unit from your Recurly site

List Sites`recurly_list_sites`

Retrieve a list of sites associated with your Recurly account

Get Site`recurly_get_site`

Fetch a specific site by its ID or subdomain

List Custom Field Definitions`recurly_list_custom_field_definitions`

Retrieve a paginated list of all custom field definitions on your Recurly site

Get Custom Field Definition`recurly_get_custom_field_definition`

Fetch a specific custom field definition by its ID

List Dunning Campaigns`recurly_list_dunning_campaigns`

Retrieve the dunning campaigns for a site

Get Dunning Campaign`recurly_get_dunning_campaign`

Fetch a specific dunning campaign by its ID

Bulk Update Dunning Campaign Plans`recurly_put_dunning_campaign_bulk_update`

Assign a dunning campaign to multiple plans

List Account Acquisitions`recurly_list_account_acquisition`

List a site's account acquisition data

Get Account Acquisition`recurly_get_account_acquisition`

Fetch an account's acquisition data

Update Account Acquisition`recurly_update_account_acquisition`

Update an account's acquisition data

Remove Account Acquisition`recurly_remove_account_acquisition`

Remove an account's acquisition data

List Business Entities`recurly_list_business_entities`

List business entities for a site

Get Business Entity`recurly_get_business_entity`

Fetch a business entity by ID

List Invoice Templates`recurly_list_invoice_templates`

Show the invoice templates for a site

Get Invoice Template`recurly_get_invoice_template`

Fetch an invoice template by ID

Get Export Dates`recurly_get_export_dates`

List the dates that have an available export to download

Get Export Files`recurly_get_export_files`

List the export files available to download for a given date

List Price Segments`recurly_list_price_segments`

List a site's price segments

Get Price Segment`recurly_get_price_segment`

Fetch a price segment by ID or code


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.