recurly v0.1.3 API Reference
Modules
Getting Started
Module for making HTTP requests to Recurly servers
Module represents a generic APIError with a symbol
and description
Module for logging HTTP requests and responses
Module for handling accounts in Recurly. See the developer docs on accounts for more details
Module for handling plan addons in Recurly. See the developer docs on plan addons for more details
Module representing an address in Recurly
Module for handling adjustments in Recurly. See the developer docs on adjustments for more details
Represents an association (link) in the xml.
An example would be the transactions
link and
the billing_info link on Recurly.Account
Module for handling billing infos in Recurly. See the developer docs on billing infos for more details
Module for handling coupons in Recurly. See the developer docs on coupons for more details
Module for handling invoices in Recurly. See the developer docs on invoices for more details
A module representing an amount of money that may be in different currencies. Sort of a naive implementation
Module represents a not found error (404)
Examples
This module is responsible for working with pagination data. TODO needs more docs
Module for handling plans in Recurly. See the developer docs on plans for more details
Module responsible for handling restful resources and actions. Mostly for internal use. API unstable
Module for handling subscriptions in Recurly. See the developer docs on subscriptions for more details
Module for handling subscription add ons in Recurly. See the developer docs on subscription addons for more details
Module for handling transactions in Recurly. See the developer docs on transactions for more details
Module for representing transaction details in Recurly
Module represents a validation error that you may encounter on a create or update. See the documentation on validation errors for more details
Notification for updated billing info https://dev.recurly.com/page/webhooks#section-updated-billing-information
Notification for canceled account https://dev.recurly.com/page/webhooks#section-closed-account
Notification for a canceled subscription https://dev.recurly.com/page/webhooks#section-canceled-subscription
Notification for closed invoice https://dev.recurly.com/page/webhooks#section-closed-invoice
Notification for a expired subscription https://dev.recurly.com/page/webhooks#section-expired-subscription
Notification for a failed payment https://dev.recurly.com/page/webhooks#section-failed-payment-only-for-ach-payments-
Notification for new account https://dev.recurly.com/page/webhooks#section-new-account
Notification for a new invoice https://dev.recurly.com/page/webhooks#invoice-notifications
Notification for a new subscription https://dev.recurly.com/page/webhooks#section-new-subscription
Notification for a new invoice https://dev.recurly.com/page/webhooks#section-past-due-invoichttps://dev.recurly.com/page/webhooks#invoice-notifications
Notification for processing invoice (ACH only) https://dev.recurly.com/page/webhooks#section-processing-invoice-automatic-only-for-ach-payments-
Notification for a processing payment (ACH only) https://dev.recurly.com/page/webhooks#section-processing-payment-only-for-ach-payments-
Notification for reactivated account https://dev.recurly.com/page/webhooks#section-reactivated-account
Notification for a renewed subscription https://dev.recurly.com/page/webhooks#section-renewed-subscription
Notification for a scheduled payment (ACH only) https://dev.recurly.com/page/webhooks#section-scheduled-payment-only-for-ach-payments-
Notification for a successful payment https://dev.recurly.com/page/webhooks#section-successful-payment-only-for-ach-payments-
Notification for a successful refund https://dev.recurly.com/page/webhooks#section-successful-refund
Notification for an updated subscription https://dev.recurly.com/page/webhooks#section-updated-subscription
Notification for a voided payment https://dev.recurly.com/page/webhooks#section-void-payment
Module responsible for building XML documents. Mostly for internal use. API unstable
Represents a schema field
Module responsible for handling schemas of the resources. Schemas are used for building the resource structs as well as marshalling and unmarshalling the xml. The syntax for defining schemas is similar to Ecto
Module for working with xml types. Mostly useful for internal use
Protocols
Protocol responsible for parsing xml into resources TODO - This still has some refactoring that can be done