Logo
Recurly Logo

Recurly APIs

Recurly provides enterprise-class subscription billing management for thousands of businesses worldwide.

Developer

Recurly APIs

Account Request URL

https://app.recurly.com/signup

Base Endpoint

v3.recurly.com

Account

Retrieve an account.

GET

accounts/:account_id

Account

Update an account.

accounts/:account_id

account_code, bill_to_address_attributes, billing_info_attributes, company_name, email, first_name, invoice_collection_method, language, last_name, name, notes, payment_method, purchase_order, tax_exempt, tax_status, terms_and_conditions, vat_number, website

Account

Create or update an account.

POST

accounts

account_code, bill_to_address_attributes, billing_info_attributes, company_name, email, first_name, invoice_collection_method, language, last_name, name, notes, payment_method, purchase_order, tax_exempt, tax_status, terms_and_conditions, vat_number, website

AccountBillingInfo

Retrieve a billing info.

GET

account_billing_infos/:account_billing_info_id

AccountBillingInfo

Update a billing info.

PUT

account_billing_infos/:account_billing_info_id

account_id, address, amazon_billing_agreement_id, bank_account_attributes, billing_agreement_id, card_attributes, iban, name, payment_method, paypal_billing_agreement_id, token, type, valid

AccountSubscription

Update a subscription for an account.

accounts/:account_id/subscriptions/:subscription_id

quantity, renewal_billing_cycles, state

Adjustment

Create an adjustment.

POST

adjustments

account, amount, created_at, description, origin, quantity, subscription, tax_exempt, type, unit_amount

Coupon

Retrieve a coupon.

GET

coupons/:coupon_id

Coupon

Create a coupon.

POST

coupons

applies_to_all_plans, coupon_code, currency, description, discount_percent, discount_type, duration, expire_date, invoice_description, max_redemptions, name, redemption_count, redemption_limit, starts_at, tax_exempt, total_redemptions, unique_coupon_code, usage_count, usage_limit

Coupon

Update a coupon.

PUT

coupons/:coupon_id

applies_to_all_plans, coupon_code, description, discount_percent, discount_type, duration, expire_date, invoice_description, max_redemptions, name, redemption_count, redemption_limit, starts_at, tax_exempt, total_redemptions, usage_count, usage_limit

CouponRedemption

Retrieve a coupon redemption.

GET

coupon_redemptions/:coupon_redemption_id

Dunning

Retrieve a dunning.

GET

dunnings/:dunning_id

Invoice

Retrieve an invoice.

GET

invoices/:invoice_id

Invoice

Create an invoice.

POST

invoices

account, closed_at, invoice_date, original_lines, tax_type, terms_and_conditions, vat_number

InvoiceItem

Retrieve an invoice item.

GET

invoice_items/:invoice_item_id

Order

Create a new order.

POST

orders

account, add_ons, billing_info_id, currency, customer_notes, gateway_code, items, line_items, notes, order_number, payment_method, purchase_order, shipping_address, shipping_method, source, state, tax_inclusive, tax_rate, total

Payment

Retrieve a payment.

GET

payments/:payment_id

Payment

Create a one-off payment.

POST

payments

account, amount, currency, invoice, order, payment_method, source, type

Plan

Retrieve a plan.

GET

plans/:plan_id

Plan

Create a plan.

POST

plans

add_ons, archived, available_add_ons, create_date, description, display_name, hosted_pages, invoice_description, setup_fee, tax_exempt, tiers

Refund

Issue a refund.

POST

refunds

account, amount, currency, invoice, reason, source

Subscription

Retrieve a subscription.

GET

subscriptions/:subscription_id

Subscription

Create a subscription.

POST

subscriptions

account, auto_renew, billing_info_id, coupon_code, create_date, currency, hosted_pages, invoice_collection_method, invoice_description, net_terms, payment_method, plan_code, quantity, renewal_billing_cycles, setup_fee, state, tax_exempt, terms_and_conditions, total_billing_cycles, trial_ends_at, trial_start_date

Details

Popular

Provider

Country HQ

API Type

REST

Categories

Payment Processing

Alternatives

Important URLs

Last Updated on

2024-03-12

Created At

2023-12-14

Other Apps

Upskill for a better future

Want to start tracking API at scale?

Get updates about your favorite APIs and SDKs

Contact Us

We do our best to ensure that the data we release is complete, accurate, and useful. However, because we are not able to verify all the data, and because the processing required to make the data useful is complex, we cannot be held liable for omissions or inaccuracies.

ApiRefs Logo