Articles in this section

Supported Recurly APIs

When you configure an export, import, or another type of flow step using the form view designed for the Recurly connector, the following API operations are supported:

Contents

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

Billing info

Fetch an account's billing information

X

 

Remove an account's billing information

 

X

Verify an account's credit card billing information

 

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 invoices

 

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

Plan

List a site's plan

X

 

Fetch a plan

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

Transaction

List an account's transactions

X

 

List a site's transactions

X

 

Fetch a transaction

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

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.