Menu
Recurly actions
Pick an action to see its parameters, request body and response fields.
202 actions
account · 13
POSTCreate Account
/accountsCreate an accountDELETEDeactivate Account/accounts/{account_id}Deactivate an accountGETGet Account/accounts/{account_id}Fetch an accountGETGet Account Balance/accounts/{account_id}/balanceFetch an account's balance and past due statusGETList Account External Invoices/accounts/{account_id}/external_invoicesList the external invoices on an accountGETList Account External Subscriptions/accounts/{account_id}/external_subscriptionsList an account's external subscriptionsGETList Accounts/accountsList a site's accountsGETList Child Accounts/accounts/{account_id}/accountsList an account's child accountsGETList Entitlements/accounts/{account_id}/entitlementsList entitlements granted to an accountGETList Invoice Template Accounts/invoice_templates/{invoice_template_id}/accountsList an invoice template's associated accountsPUTReactivate Account/accounts/{account_id}/reactivateReactivate an inactive accountPUTRedact Account/accounts/{account_id}/redactRedact an account (GDPR Right to Erasure)PUTUpdate Account/accounts/{account_id}Update an accountaccount_acquisition · 4
GETGet Account Acquisition
/accounts/{account_id}/acquisitionFetch an account's acquisition dataGETList Account Acquisition/acquisitionsList a site's account acquisition dataDELETERemove Account Acquisition/accounts/{account_id}/acquisitionRemove an account's acquisition dataPUTUpdate Account Acquisition/accounts/{account_id}/acquisitionUpdate an account's acquisition dataadd-on · 7
POSTCreate Plan Add On
/plans/{plan_id}/add_onsCreate an add-onGETGet Add On/add_ons/{add_on_id}Fetch an add-onGETGet Plan Add On/plans/{plan_id}/add_ons/{add_on_id}Fetch a plan's add-onGETList Add Ons/add_onsList a site's add-onsGETList Plan Add Ons/plans/{plan_id}/add_onsList a plan's add-onsDELETERemove Plan Add On/plans/{plan_id}/add_ons/{add_on_id}Remove an add-onPUTUpdate Plan Add On/plans/{plan_id}/add_ons/{add_on_id}Update an add-onautomated_exports · 2
billing_info · 5
GETGet Billing Info
/accounts/{account_id}/billing_infoFetch an account's billing informationDELETERemove Billing Info/accounts/{account_id}/billing_infoRemove an account's billing informationPUTUpdate Billing Info/accounts/{account_id}/billing_infoSet an account's billing informationPOSTVerify Billing Info/accounts/{account_id}/billing_info/verifyVerify an account's credit card billing informationPOSTVerify Billing Info Cvv/accounts/{account_id}/billing_info/verify_cvvVerify an account's credit card billing cvvbilling_infos · 7
POSTCreate Billing Info
/accounts/{account_id}/billing_infosAdd new billing information on an accountGETGet A Billing Info/accounts/{account_id}/billing_infos/{billing_info_id}Fetch a billing infoGETList Billing Infos/accounts/{account_id}/billing_infosGet the list of billing information associated with an accountDELETERemove A Billing Info/accounts/{account_id}/billing_infos/{billing_info_id}Remove an account's billing informationPUTUpdate A Billing Info/accounts/{account_id}/billing_infos/{billing_info_id}Update an account's billing informationPOSTVerify Billing Infos/accounts/{account_id}/billing_infos/{billing_info_id}/verifyVerify a billing information's credit cardPOSTVerify Billing Infos Cvv/accounts/{account_id}/billing_infos/{billing_info_id}/verify_cvvVerify a billing information's credit card cvvbusiness_entities · 2
coupon · 6
POSTCreate Coupon
/couponsCreate a new couponDELETEDeactivate Coupon/coupons/{coupon_id}Expire a couponGETGet Coupon/coupons/{coupon_id}Fetch a couponGETList Coupons/couponsList a site's couponsPUTRestore Coupon/coupons/{coupon_id}/restoreRestore an inactive couponPUTUpdate Coupon/coupons/{coupon_id}Update an active couponcoupon_redemption · 10
POSTCreate Coupon Redemption
/accounts/{account_id}/coupon_redemptions/activeGenerate an active coupon redemption on an account or subscriptionGETGet Coupon Redemption/accounts/{account_id}/coupon_redemptions/{coupon_redemption_id}Show the coupon redemptionGETGet Subscription Coupon Redemption/subscriptions/{subscription_id}/coupon_redemptions/{coupon_redemption_id}Show the coupon redemption for a subscriptionGETList Account Coupon Redemptions/accounts/{account_id}/coupon_redemptionsList the coupon redemptions for an accountGETList Active Coupon Redemptions/accounts/{account_id}/coupon_redemptions/activeList the coupon redemptions that are active on an accountGETList Invoice Coupon Redemptions/invoices/{invoice_id}/coupon_redemptionsList the coupon redemptions applied to an invoiceGETList Subscription Coupon Redemptions/subscriptions/{subscription_id}/coupon_redemptionsList the coupon redemptions for a subscriptionDELETERemove Coupon Redemption/accounts/{account_id}/coupon_redemptions/activeDelete the active coupon redemption from an accountDELETERemove Coupon Redemption By Id/accounts/{account_id}/coupon_redemptions/{coupon_redemption_id}Delete the coupon redemptionDELETERemove Subscription Coupon Redemption/subscriptions/{subscription_id}/coupon_redemptions/{coupon_redemption_id}Delete the coupon redemption from a subscriptioncredit_payment · 3
custom_field_definition · 2
dunning_campaigns · 3
external_accounts · 5
POSTCreate Account External Account
/accounts/{account_id}/external_accountsCreate an external accountDELETEDelete Account External Account/accounts/{account_id}/external_accounts/{external_account_id}Delete an external account for an accountGETGet Account External Account/accounts/{account_id}/external_accounts/{external_account_id}Get an external account for an accountGETList Account External Account/accounts/{account_id}/external_accountsList external accounts for an accountPUTUpdate Account External Account/accounts/{account_id}/external_accounts/{external_account_id}Update an external accountexternal_invoices · 3
external_payment_phases · 1
external_product_references · 4
POSTCreate External Product External Product Reference
/external_products/{external_product_id}/external_product_referencesCreate an external product reference on an external productDELETEDeactivate External Product External Product Reference/external_products/{external_product_id}/external_product_references/{external_product_reference_id}Deactivate an external product referenceGETGet External Product External Product Reference/external_products/{external_product_id}/external_product_references/{external_product_reference_id}Fetch an external product referenceGETList External Product External Product References/external_products/{external_product_id}/external_product_referencesList the external product references for an external productexternal_products · 5
POSTCreate External Product
/external_productsCreate an external productDELETEDeactivate External Products/external_products/{external_product_id}Deactivate an external productGETGet External Product/external_products/{external_product_id}Fetch an external productGETList External Products/external_productsList a site's external productsPUTUpdate External Product/external_products/{external_product_id}Update an external productexternal_subscriptions · 6
POSTCreate External Subscription
/external_subscriptionsCreate an external subscriptionGETGet External Subscription/external_subscriptions/{external_subscription_id}Fetch an external subscriptionGETList External Subscription External Invoices/external_subscriptions/{external_subscription_id}/external_invoicesList the external invoices on an external subscriptionGETList External Subscription External Payment Phases/external_subscriptions/{external_subscription_id}/external_payment_phasesList the external payment phases on an external subscriptionGETList External Subscriptions/external_subscriptionsList the external subscriptions on a sitePUTPut External Subscription/external_subscriptions/{external_subscription_id}Update an external subscriptiongeneral_ledger_account · 4
POSTCreate General Ledger Account
/general_ledger_accountsCreate a new general ledger accountGETGet General Ledger Account/general_ledger_accounts/{general_ledger_account_id}Fetch a general ledger accountGETList General Ledger Accounts/general_ledger_accountsList a site's general ledger accountsPUTUpdate General Ledger Account/general_ledger_accounts/{general_ledger_account_id}Update a general ledger accountGeneric Request · 5
gift_cards · 5
invoice · 18
PUTApply Credit Balance
/invoices/{invoice_id}/apply_credit_balanceApply available credit to a pending or past due charge invoicePUTCollect Invoice/invoices/{invoice_id}/collectCollect a pending or past due, automatic invoicePOSTCreate Invoice/accounts/{account_id}/invoicesCreate an invoice for pending line itemsGETGet Invoice/invoices/{invoice_id}Fetch an invoiceGETGet Invoice Pdf/invoices/{invoice_id}.pdfFetch an invoice as a PDFGETList Account Invoices/accounts/{account_id}/invoicesList an account's invoicesGETList Business Entity Invoices/business_entities/{business_entity_id}/invoicesList a business entity's invoicesGETList Invoices/invoicesList a site's invoicesGETList Related Invoices/invoices/{invoice_id}/related_invoicesList an invoice's related credit or charge invoicesGETList Subscription Invoices/subscriptions/{subscription_id}/invoicesList a subscription's invoicesPUTMark Invoice Failed/invoices/{invoice_id}/mark_failedMark an open invoice as failedPUTMark Invoice Successful/invoices/{invoice_id}/mark_successfulMark an open invoice as successfulPOSTPreview Invoice/accounts/{account_id}/invoices/previewPreview new invoice for pending line itemsPOSTRecord External Transaction/invoices/{invoice_id}/transactionsRecord an external payment for a manual invoices.POSTRefund Invoice/invoices/{invoice_id}/refundRefund an invoicePUTReopen Invoice/invoices/{invoice_id}/reopenReopen a closed, manual invoicePUTUpdate Invoice/invoices/{invoice_id}Update an invoicePUTVoid Invoice/invoices/{invoice_id}/voidVoid a credit invoice.invoice_templates · 2
item · 6
line_item · 7
POSTCreate Line Item
/accounts/{account_id}/line_itemsCreate a new line item for the accountGETGet Line Item/line_items/{line_item_id}Fetch a line itemGETList Account Line Items/accounts/{account_id}/line_itemsList an account's line itemsGETList Invoice Line Items/invoices/{invoice_id}/line_itemsList an invoice's line itemsGETList Line Items/line_itemsList a site's line itemsGETList Subscription Line Items/subscriptions/{subscription_id}/line_itemsList a subscription's line itemsDELETERemove Line Item/line_items/{line_item_id}Delete an uninvoiced line itemmeasured_unit · 5
POSTCreate Measured Unit
/measured_unitsCreate a new measured unitGETGet Measured Unit/measured_units/{measured_unit_id}Fetch a measured unitGETList Measured Unit/measured_unitsList a site's measured unitsDELETERemove Measured Unit/measured_units/{measured_unit_id}Remove a measured unitPUTUpdate Measured Unit/measured_units/{measured_unit_id}Update a measured unitnote · 4
POSTCreate Account Note
/accounts/{account_id}/notesCreate an account noteGETGet Account Note/accounts/{account_id}/notes/{account_note_id}Fetch an account noteGETList Account Notes/accounts/{account_id}/notesList an account's notesDELETERemove Account Note/accounts/{account_id}/notes/{account_note_id}Delete an account noteperformance_obligations · 2
plan · 5
price_segment · 2
purchase · 6
POSTCancel Purchase
/purchases/{transaction_id}/cancel/Cancel PurchasePOSTCreate Authorize Purchase/purchases/authorizeAuthorize a purchasePOSTCreate Capture Purchase/purchases/{transaction_id}/captureCapture a purchasePOSTCreate Pending Purchase/purchases/pendingCreate a pending purchasePOSTCreate Purchase/purchasesCreate a new purchasePOSTPreview Purchase/purchases/previewPreview a new purchaserevenue_recovery · 1
shipping_address · 5
POSTCreate Shipping Address
/accounts/{account_id}/shipping_addressesCreate a new shipping address for the accountGETGet Shipping Address/accounts/{account_id}/shipping_addresses/{shipping_address_id}Fetch an account's shipping addressGETList Shipping Addresses/accounts/{account_id}/shipping_addressesFetch a list of an account's shipping addressesDELETERemove Shipping Address/accounts/{account_id}/shipping_addresses/{shipping_address_id}Remove an account's shipping addressPUTUpdate Shipping Address/accounts/{account_id}/shipping_addresses/{shipping_address_id}Update an account's shipping addressshipping_method · 5
POSTCreate Shipping Method
/shipping_methodsCreate a new shipping methodDELETEDeactivate Shipping Method/shipping_methods/{shipping_method_id}Deactivate a shipping methodGETGet Shipping Method/shipping_methods/{shipping_method_id}Fetch a shipping methodGETList Shipping Methods/shipping_methodsList a site's shipping methodsPUTUpdate Shipping Method/shipping_methods/{shipping_method_id}Update an active Shipping Methodsite · 2
subscription · 12
PUTCancel Subscription
/subscriptions/{subscription_id}/cancelCancel a subscriptionPUTConvert Trial/subscriptions/{subscription_id}/convert_trialConvert trial subscriptionPOSTCreate Subscription/subscriptionsCreate a new subscriptionGETGet Preview Renewal/subscriptions/{subscription_id}/preview_renewalFetch a preview of a subscription's renewal invoice(s)GETGet Subscription/subscriptions/{subscription_id}Fetch a subscriptionGETList Account Subscriptions/accounts/{account_id}/subscriptionsList an account's subscriptionsGETList Subscriptions/subscriptionsList a site's subscriptionsPUTPause Subscription/subscriptions/{subscription_id}/pausePause subscriptionPUTReactivate Subscription/subscriptions/{subscription_id}/reactivateReactivate a canceled subscriptionPUTResume Subscription/subscriptions/{subscription_id}/resumeResume subscriptionDELETETerminate Subscription/subscriptions/{subscription_id}Terminate a subscriptionPUTUpdate Subscription/subscriptions/{subscription_id}Update a subscriptionsubscription_change · 4
POSTCreate Subscription Change
/subscriptions/{subscription_id}/changeCreate a new subscription changeGETGet Subscription Change/subscriptions/{subscription_id}/changeFetch a subscription's pending changePOSTPreview Subscription Change/subscriptions/{subscription_id}/change/previewPreview a new subscription changeDELETERemove Subscription Change/subscriptions/{subscription_id}/changeDelete the pending subscription changetransaction · 3
unique_coupon_code · 6
DELETEDeactivate Unique Coupon Code
/unique_coupon_codes/{unique_coupon_code_id}Deactivate a unique coupon codePOSTGenerate Unique Coupon Codes/coupons/{coupon_id}/generateGenerate unique coupon codesPOSTGenerate Unique Coupon Codes Sync/coupons/{coupon_id}/generate_syncGenerate unique coupon codes synchronouslyGETGet Unique Coupon Code/unique_coupon_codes/{unique_coupon_code_id}Fetch a unique coupon codeGETList Unique Coupon Codes/coupons/{coupon_id}/unique_coupon_codesList unique coupon codes associated with a bulk couponPUTReactivate Unique Coupon Code/unique_coupon_codes/{unique_coupon_code_id}/restoreRestore a unique coupon codeusage · 5
POSTCreate Usage
/subscriptions/{subscription_id}/add_ons/{add_on_id}/usageLog a usage record on this subscription add-onGETGet Usage/usage/{usage_id}Get a usage recordGETList Usage/subscriptions/{subscription_id}/add_ons/{add_on_id}/usageList a subscription add-on's usage recordsDELETERemove Usage/usage/{usage_id}Delete a usage record.PUTUpdate Usage/usage/{usage_id}Update a usage record