Articles in this section

Available Recurly APIs

When you configure an export, import, or other type of flow step using the prebuilt Recurly connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Recurly API documentation. You can also create a composite endpoint for this application in HTTP mode.

API v3 version

Resource

API endpoint

Export

Import

Account

List a site's accounts

X

Fetch an account

X

Fetch an account's balance and past dues

X

List an account's child account

X

Create accounts

X

Update an account

X

Reactivate an inactive account

X

Deactivate an account

X

List an account's external subscriptions

X

List an invoice template's associated accounts

X

List entitlements granted to an account

X

List the external invoices on an account

X

Account acquisition

Lookup account acquisition

X

Create account acquisition

X

Update account acquisition

X

Clear account acquisition

X

Fetch an account's acquisition data

X

List a site's account acquisition data

X

Remove an account's acquisition data

X

Update an account's acquisition data

X

Accounts

List accounts

X

Lookup account

X

Lookup account balance

X

List account notes

X

Create account

X

Update account

X

Close account

X

List accounts

X

Lookup account

X

Lookup account balance

X

List account notes

X

Create account

X

Update account

X

Reopen account

X

Close account

X

Add-on

Create an add-on

X

Fetch a plan's add-on

X

Fetch an add-on

X

List a plan's add-ons

X

List a site's add-ons

X

Remove an add-on

X

Update an add-on

X

Adjustments

List account's adjustments

X

List account's adjustments

X

Create charge

X

Create credit

X

Delete adjustment

X

Automated exports

List export dates

X

List date's export files

X

List of the export files that are available to download

X

List the dates that have an available export to download

X

Billing info

Lookup account's billing info

X

Create account's billing info (token)

X

Create account's billing info (credit card)

X

Create account's billing info (bank account)

X

Create account's billing info (external token)

X

Update account's billing info (token)

X

Update account's billing info (credit card)

X

Update account's billing info (bank account)

X

Update account's billing info (using external token)

X

Clear account's billing info

X

Fetch an account's billing information

X

Remove an account's billing information

X

Verify an account's credit card billing information

X

Set an account's billing information

X

Verify an account's credit card billing CVV

X

Billing infos

Add new billing information on an account

X

Fetch a billing info

X

Get the list of billing information associated with an account

X

Remove an account's billing information

X

Update an account's billing information

X

Verify a billing information's credit card CVV

X

Verify a billing information's credit card

X

Business entities

Fetch a business entity

X

List business entities

X

Coupon

Create a new coupon

X

Expire a coupon

X

Fetch a coupon

X

List a site's coupons

X

Restore an inactive coupon

X

Update an active coupon

X

Coupon redemption

Delete the active coupon redemption from an account

X

Delete the coupon redemption

X

Delete the coupon redemption from a subscription

X

Generate an active coupon redemption on an account or subscription

X

List the coupon redemptions applied to an invoice

X

List the coupon redemptions for a subscription

X

List the coupon redemptions for an account

X

List the coupon redemptions that are active on an account

X

Show the coupon redemption for a subscription

X

Show the coupon redemption

X

Coupon redemptions

List account's coupon redemptions

X

List invoice's coupon redemptions

X

List subscription's coupon redemption

X

Redeem coupon on account

X

Remove coupon redemption from account

X

Coupons

List coupons

X

Lookup coupon

X

List unique coupon codes

X

Create coupon

X

Generate unique codes

X

Edit coupon

X

Restore coupon

X

Expire coupon

X

Create coupon

X

Edit coupon

X

Expire coupon

X

Credit payment

Fetch a credit payment

X

List a site's credit payments

X

List an account's credit payments

X

Credit payments

List credit payments

X

List credit payments on account

X

Lookup credit payment

X

Custom field definition

Fetch a custom field definition

X

List a site's custom field definitions

X

Dunning campaigns

Assign a dunning campaign to multiple plans

X

Fetch a dunning campaign

X

List the dunning campaigns for a site

X

External accounts

Create an external account

X

Delete an external account for an account

X

Get an external account for an account

X

List external accounts for an account

X

Update an external account

X

External invoices

Create an external invoice

X

Fetch an external invoice

X

List the external invoices on a site

X

External payment phases

Fetch an external payment phase

X

External product references

Create an external product reference on an external product

X

Deactivate an external product reference

X

Fetch an external product reference

X

List the external product references for an external product

X

External products

Create an external product

X

Deactivate an external product

X

Fetch an external product

X

List a site's external products

X

Update an external product

X

External subscriptions

Create an external subscription

X

Fetch an external subscription

X

List the external invoices on an external subscription

X

List the external payment phases on an external subscription

X

List the external subscriptions on a site

X

Update an external subscription

X

General ledger account

Create a new general ledger account

X

Fetch a general ledger account

X

List a site's general ledger accounts

X

Update a general ledger account

X

Gift cards

List gift cards

X

Lookup gift card

X

Preview gift card

X

Create gift card

X

Redeem gift card on account

X

Preview subscription with gift card redemption

X

Create subscription with gift card redemption

X

Create gift card

X

Fetch a gift card

X

List gift cards

X

Preview gift card

X

Redeem gift card

X

Invoice

List an account's invoices

X

Fetch an invoice

X

List subscription's invoices

X

List a site's invoices

X

Record an external payment for a manual invoice

X

Refund an invoice

X

Update an invoice

X

Mark an open invoice as successful

X

Reopen a closed manual invoice

X

Mark an open invoice as failed

X

Void a credit invoice

X

Apply available credit to a pending or past due charge invoice

X

Collect a pending or past due automatic invoice

X

Create an invoice for pending line items

X

List a business entity's invoices

X

List an invoice's related credit or charge invoices

X

Preview new invoice for pending line items

X

Invoice templates

Fetch an invoice template

X

Show the invoice templates for a site

X

Invoices

List invoices

X

List account's invoices

X

Lookup invoice

X

Preview invoice

X

Post invoice: invoice pending adjustments on account

X

Refund/void line items

X

Refund/void open amount

X

Enter offline payment for manual invoice

X

Collect an invoice

X

Mark invoice as paid successfully

X

Mark invoice as failed collection

X

Void a credit invoice

X

Edit invoice

X

Item

Create a new item

X

Deactivate an item

X

Fetch an item

X

List a site's items

X

Reactivate an inactive item

X

Update an active item

X

Line item

Create a new line item for the account

X

Delete an uninvoiced line item

X

Fetch a line item

X

List a site's line items

X

List a subscription's line items

X

List an account's line items

X

List an invoice's line items

X

Measured unit

Create a new measured unit

X

Fetch a measured unit

X

List a site's measured units

X

Remove a measured unit

X

Update a measured unit

X

Measured units

List measured units

X

Lookup measured unit

X

Create measured unit

X

Update measured unit

X

Delete measured unit

X

Note

Create an account note

X

Delete an account note

X

Fetch an account note

X

List an account's notes

X

Performance obligations

Get a single performance obligation

X

Get a site's performance obligations

X

Plan

List a site's plan

X

Fetch a plan

X

Create a plan

X

Remove a plan

X

Update a plan

X

Plan add-ons

List plan's add-ons

X

Lookup plan add-on

X

Create plan add-on

X

Update plan add-on

X

Delete plan add-on

X

Plans

List plans

X

Lookup plan

X

Create plan

X

Update plan

X

Delete plan

X

Price segment

Fetch a price segment

X

List a site's price segments

X

Purchase

Authorize a purchase

X

Cancel purchase

X

Capture a purchase

X

Create a new purchase

X

Create a pending purchase

X

Preview a new purchase

X

Shipping address

Create a new shipping address for the account

X

Fetch a list of an account's shipping addresses

X

Fetch an account's shipping address

X

Remove an account's shipping address

X

Update an account's shipping address

X

Shipping addresses

List account's shipping address

X

Create shipping address

X

Update shipping address

X

Delete shipping address

X

Shipping method

Create a new shipping method

X

Deactivate a shipping method

X

Fetch a shipping method

X

List a site's shipping methods

X

Update an active shipping method

X

Site

Fetch a site

X

List sites

X

Subscription

List a site's subscription

X

List an account's subscription

X

Fetch a subscription

X

Fetch a preview of a subscription's renewal invoice

X

Update a subscription

X

Create new subscription

X

Pause a subscription

X

Resume subscription

X

Cancel a subscription

X

Reactivate canceled subscription

X

Terminate a subscription

X

Convert trial subscription

X

Subscription change

Create a new subscription change

X

Delete the pending subscription change

X

Fetch a subscription's pending change

X

Preview a new subscription change

X

Subscription usage records

List subscriptions add-ons usage

X

Lookup usage record

X

Lookup subscription

X

Log usage

X

Update usage record

X

Delete usage record

X

Subscriptions

List subscriptions

X

List account's subscriptions

X

Lookup subscription

X

Preview subscription

X

Create subscription

X

Create subscription with add-ons

X

Preview subscription change

X

Create subscription with custom fields

X

Update subscription

X

Update subscription with add-ons

X

Update subscription notes

X

Cancel subscription

X

Reactivate canceled subscription

X

Pause subscription

X

Resume subscription

X

Update subscription with custom fields

X

Transaction

List an account's transactions

X

List a site's transactions

X

Fetch a transaction

X

Transactions

List transactions

X

List account's transactions

X

Lookup transaction

X

Create transaction

X

Unique coupon code

Deactivate a unique coupon code

X

Fetch a unique coupon code

X

Generate unique coupon codes

X

List unique coupon codes associated with a bulk coupon

X

Restore a unique coupon code

X

Usage

Delete a usage record

X

Get a usage record

X

List a subscription add-on's usage records

X

Log a usage record on this subscription add-on

X

Update a usage record

X

API v2 version

Resource

API endpoint

Export

Import

Account acquisition

Lookup account acquisition

X

Create account acquisition

X

Update account acquisition

X

Clear account acquisition

X

Accounts

List accounts

X

Lookup account

X

Lookup account balance

X

List account notes

X

Create account

X

Update account

X

Close account

X

List accounts

X

Lookup account

X

Lookup account balance

X

List account notes

X

Create account

X

Update account

X

Reopen account

X

Close account

X

Adjustments

List account's adjustments

X

List account's adjustments

X

Create charge

X

Create credit

X

Delete adjustment

X

Automated exports

List export dates

X

List date's export files

X

Billing info

Lookup account's billing info

X

Create account's billing info (token)

X

Create account's billing info (credit card)

X

Create account's billing info (bank account)

X

Create account's billing info (external token)

X

Update account's billing info (token)

X

Update account's billing info (credit card)

X

Update account's billing info (bank account)

X

Update account's billing info (using external token)

X

Clear account's billing info

X

Coupon redemptions

List account's coupon redemptions

X

List invoice's coupon redemptions

X

List subscription's coupon redemption

X

Redeem coupon on account

X

Remove coupon redemption from account

X

Coupons

List coupons

X

Lookup coupon

X

List unique coupon codes

X

Create coupon

X

Generate unique codes

X

Edit coupon

X

Restore coupon

X

Expire coupon

X

Create coupon

X

Edit coupon

X

Expire coupon

X

Credit payments

List credit payments

X

List credit payments on account

X

Lookup credit payment

X

Gift cards

List gift cards

X

Lookup gift card

X

Preview gift card

X

Create gift card

X

Redeem gift card on account

X

Preview subscription with gift card redemption

X

Create subscription with gift card redemption

X

Invoices

List invoices

X

List account's invoices

X

Lookup invoice

X

Preview invoice

X

Post invoice: invoice pending adjustments on account

X

Refund/void line items

X

Refund/void open amount

X

Enter offline payment for manual invoice

X

Collect an invoice

X

Mark invoice as paid successfully

X

Mark invoice as failed collection

X

Void a credit invoice

X

Edit invoice

X

Measured units

List measured units

X

Lookup measured unit

X

Create measured unit

X

Update measured unit

X

Delete measured unit

X

Plan add-ons

List plan's add-ons

X

Lookup plan add-on

X

Create plan add-on

X

Update plan add-on

X

Delete plan add-on

X

Plans

List plans

X

Lookup plan

X

Create plan

X

Update plan

X

Delete plan

X

Shipping addresses

List account's shipping address

X

Create shipping address

X

Update shipping address

X

Delete shipping address

X

Subscription usage records

List subscriptions add-on's usage

X

Lookup usage record

X

Lookup subscription

X

Log usage

X

Update usage record

X

Delete usage record

X

Subscriptions

List subscriptions

X

List account's subscriptions

X

Lookup subscription

X

Preview subscription

X

Create subscription

X

Create subscription with add-ons

X

Preview subscription change

X

Create subscription with custom fields

X

Update subscription

X

Update subscription with add-ons

X

Update subscription notes

X

Cancel subscription

X

Reactivate canceled subscription

X

Pause subscription

X

Resume subscription

X

Update subscription with custom fields

X

Transactions

List transactions

X

List account's transactions

X

Lookup transaction

X

Create transaction

X