API Data Provider - Online Help

Recurly Tables

The provider models the data in API into a list of tables that can be queried using standard SQL statements.

Generally, querying API tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

Recurly Tables

Name Description
AccountAcquisition Returns an account's acquisition data.
AccountCreditPayments Returns a list of an account's credit payments.
AccountInvoices Returns a list of an account's invoices.
AccountLineItems Returns a list of an account's line items.
AccountNotes Returns a list of an account's notes.
Accounts Returns a list of accounts on your site.
AccountTransactions Returns a list of an account's transactions.
Acquisitions Returns a site's account acquisition data.
ActiveCouponRedemptions Returns the coupon redemptions that are active on an account.
Addons List a site's add-ons.
BillingInfo Returns only the account's current billing information.
CouponRedemptions Returns information about the coupon redemptions on an account.
Coupons Returns a list of all the coupons.
CreditPayments List all credit payments on the site
InvoiceCouponRedemptions Returns the coupon redemptions applied to an invoice.
Invoices Returns a site's invoices.
Items Returns a list of site's items.
LineItems Returns a list of site's line items.
MeasuredUnits List all measured units for your site.
PlanAddOns Returns a list of all the add-ons for a plan.
Plans List a site's plans.
ShippingAddresses Returns a list of shipping addresses for an account.
ShippingMethods Returns a list of site's shipping methods.
Sites Returns a list of sites.
SubscriptionCouponRedemptions Returns active coupon redemptions associated with the specific subscription.
SubscriptionInvoices Returns a list of an subscription's invoices.
SubscriptionLineItems Returns a list of an subscription's line items.
SubscriptionPendingChange Returns a subscription's pending change.
Subscriptions Returns a site's subscriptions.
SubscriptionUsages Returns a subscription add-on's usage records.
Transactions Returns a list of all transactions.
UniqueCouponCodes Returns unique coupon codes associated with a bulk coupon.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8487.0