A Recurly API client written in golang. Actively maintained and unit tested.
Go
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
mock Added LookupAccountBalance Jan 16, 2017
webhooks Rename go-recurly to recurly Jan 4, 2017
.travis.yml Add interfaces and mocks (#10) Jan 3, 2017
LICENSE.txt More unit tests. Add License and readme Jul 28, 2015
README.md
accounts.go Removed custom unmarshaller Jan 16, 2017
accounts_service.go Added LookupAccountBalance Jan 16, 2017
accounts_test.go Fixed Unmarshal bugs Jan 16, 2017
add_ons.go Add interfaces and mocks (#10) Jan 3, 2017
add_ons_service.go Add interfaces and mocks (#10) Jan 3, 2017
add_ons_test.go Export DateTimeFormat Jan 4, 2017
adjustments.go Revert href types to unexported Jan 4, 2017
adjustments_service.go Add interfaces and mocks (#10) Jan 3, 2017
adjustments_test.go Export DateTimeFormat Jan 4, 2017
billing.go Add interfaces and mocks (#10) Jan 3, 2017
billing_service.go Add interfaces and mocks (#10) Jan 3, 2017
billing_test.go Rename go-recurly to recurly Jan 4, 2017
client.go
client_internal_test.go Set Authorization header in calls to Recurly (#16) Jan 18, 2017
client_test.go Rename go-recurly to recurly Jan 4, 2017
coupons.go Add interfaces and mocks (#10) Jan 3, 2017
coupons_service.go Add interfaces and mocks (#10) Jan 3, 2017
coupons_test.go Export DateTimeFormat Jan 4, 2017
invoices.go
invoices_service.go Sort invoice transactions from oldest to newest (#14) Jan 17, 2017
invoices_test.go Sort invoice transactions from oldest to newest (#14) Jan 17, 2017
plans.go Add interfaces and mocks (#10) Jan 3, 2017
plans_service.go
plans_test.go Export DateTimeFormat Jan 4, 2017
redemptions.go Revert href types to unexported Jan 4, 2017
redemptions_service.go Add interfaces and mocks (#10) Jan 3, 2017
redemptions_test.go
response_test.go Rename go-recurly to recurly Jan 4, 2017
responses.go
services.go Added LookupAccountBalance Jan 16, 2017
subscriptions.go
subscriptions_service.go Add interfaces and mocks (#10) Jan 3, 2017
subscriptions_test.go Add PendingSubscription to subscription struct for renewal updates (#17) Jan 24, 2017
transactions.go Sort invoice transactions from oldest to newest (#14) Jan 17, 2017
transactions_service.go Add interfaces and mocks (#10) Jan 3, 2017
transactions_test.go Rename go-recurly to recurly Jan 4, 2017
type_href.go
type_href_test.go Revert href types to unexported Jan 4, 2017
type_null_bool.go Revert href types to unexported Jan 4, 2017
type_null_bool_test.go Add interfaces and mocks (#10) Jan 3, 2017
type_null_int.go Revert href types to unexported Jan 4, 2017
type_null_int_test.go Add interfaces and mocks (#10) Jan 3, 2017
type_null_marshal.go Add interfaces and mocks (#10) Jan 3, 2017
type_null_time.go
type_null_time_test.go Export DateTimeFormat Jan 4, 2017
type_unit_amount.go
type_unit_amount_test.go Add interfaces and mocks (#10) Jan 3, 2017

README.md

Recurly

Recurly is a Go (golang) API Client for the Recurly API.

Build Status GoDoc

References

Installation

Install using the "go get" command:

go get github.com/blacklightcms/recurly

Example

import "github.com/blacklightcms/recurly"

Construct a new Recurly Client and then work off of that. For example, to list accounts:

client, err := recurly.NewClient("subdomain", "apiKey", nil)
resp, accounts, err := client.Accounts.List({"per_page": 20})

recurly.Response embeds http.Response and provides some convenience methods:

if resp.IsOK() {
    fmt.Println("Response was a 200-299 status code")
} else if resp.IsError() {
    fmt.Println("Response was NOT a 200-299 status code")

    // Loop through errors (422 status code only)
    for _, e := range resp.Errors() {
        fmt.Printf("Message: %s; Field: %s; Symbol: %s\n", e.Message, e.Field, e.Symbol)
    }
}

if resp.IsClientError() {
    fmt.Println("You messed up. Response was a 400-499 status code")
} else if resp.IsServerError() {
    fmt.Println("Try again later. Response was a 500-599 status code")
}

// Get status code from http.response
if resp.StatusCode == 422 {
    // ...
}

Usage

The basic usage format is to create a client, and then operate directly off of each of the services.

The services are (each link to the GoDoc documentation):

Each of the services correspond to their respective sections in the Recurly API Documentation.

Here are a few examples:

Create Account

resp, a, err := client.Accounts.Create(recurly.Account{
    Code: "1",
    FirstName: "Verena",
    LastName: "Example",
    Email: "verena@example.com"
})

if resp.IsOK() {
    log.Printf("Account successfully created. Hosted Login Token: %s", a.HostedLoginToken)
}

Get Account

resp, a, err := client.Accounts.Get("1")
if resp.IsOK() {
    log.Printf("Account Found: %+v", a)
}

Get Accounts (pagination example)

All paginated methods (usually named List or List*) support a per_page and cursor parameter. Example usage:

resp, accounts, err := client.Accounts.List(recurly.Params{"per_page": 10})

if resp.IsError() {
    // Error occurred
}

for i, a := range accounts {
    // Loop through accounts
}

// Check for next page
next := resp.Next()
if next == "" {
    // No next page
}

// Retrieve next page
resp, accounts, err := client.Accounts.Get(recurly.Params{
    "per_page": 10,
    "cursor": next,
})

// Check for prev page
prev := resp.Prev()
if prev == "" {
    // No prev page
}

// Retrieve prev page
resp, accounts, err := client.Accounts.Get(recurly.Params{
    "per_page": 10,
    "cursor": prev,
})

Close account

resp, err := client.Accounts.Close("1")

Reopen account

resp, err := client.Accounts.Reopen("1")

Create Billing Info Using recurly.js Token

// 1 is the account code
resp, b, err := client.Billing.CreateWithToken("1", token)

Update Billing Info Using recurly.js Token

// 1 is the account code
resp, b, err := client.Billing.UpdateWithToken("1", token)

Create Billing with Credit Card

resp, b, err := client.Billing.Create("1", Billing{
    FirstName: "Verena",
    LastName:  "Example",
    Address:   "123 Main St.",
    City:      "San Francisco",
    State:     "CA",
    Zip:       "94105",
    Country:   "US",
    Number:    4111111111111111,
    Month:     10,
    Year:      2020,
})

Create Billing With Bank account

resp, b, err := client.Billing.Create("134", Billing{
    FirstName:     "Verena",
    LastName:      "Example",
    Address:       "123 Main St.",
    City:          "San Francisco",
    State:         "CA",
    Zip:           "94105",
    Country:       "US",
    NameOnAccount: "Acme, Inc",
    RoutingNumber: "123456780",
    AccountNumber: "111111111",
    AccountType:   "checking",
})

Creating Subscriptions

Subscriptions have different formats for creating and reading. Due to that, they have a special use case when creating -- a NewSubscription struct respectively. NewSubscription structs are only used for creating.

When updating a subscription, you should use the UpdateSubscription struct. All other creates/updates throughout use the same struct to create/update as to read.

// s will return a Subscription struct after creating using the
// NewSubscription struct.
resp, s, err := client.Subscriptions.Create(recurly.NewSubscription{
    Code: "gold",
    Currency: "EUR",
    Account: recurly.Account{
        Code: "b6f5783",
        Email: "verena@example.com",
        FirstName: "Verena",
        LastName: "Example",
        BillingInfo: &recurly.Billing{
            Number: 4111111111111111,
            Month: 12,
            Year: 2017,
            VerificationValue: 123,
            Address: "400 Alabama St",
            City: "San Francisco",
            State: "CA",
            Zip: "94110",
        }
    }
})

Working with Null* Types

This package has a few null types that ensure that zero values will marshal or unmarshal properly.

For example, booleans have a zero value of false in Go. If you need to explicitly send a false value, go will see that as a zero value and the omitempty option will ensure it doesn't get sent.

Likewise if you attempt to unmarshal empty/nil values into a struct, you will also get errors. The Null types help ensure things work as expected.

NullBool

NullBool is a basic struct that looks like this:

NullBool struct {
    Bool  bool
    Valid bool
}

The Valid field determines if the boolean value stored in Bool was intentionally set there, or if it should be discarded since the default will be false.

Here's how to work with NullBool:

// Create a new NullBool:
t := recurly.NewBool(true)

// Check if the value held in the bool is what you expected
fmt.Printf("%v", t.Is(true)) // true
fmt.Printf("%v", t.Is(false)) // false

If, however, NullBool looked like this:

recurly.NullBool{
    Bool: false,
    Valid: false,
}

Then those checks will always return false:

fmt.Printf("%v", t.Is(true)) // false
fmt.Printf("%v", t.Is(false)) // false

NullInt

NullInt works the same way as NullBool, but for integers.

i := recurly.NewInt(0)
i = recurly.NewInt(1)
i = recurly.NewInt(50)

NullTime

NullTime won't breakdown if an empty string / nil value is returned from the Recurly API. It also ensures times are always in UTC.

t := time.Now()
nt := recurly.NewTime(t) // time is now in UTC
fmt.Println(t.String()) // 2015-08-03T19:11:33Z

You can then use s.Account.Code to retrieve account info, or s.Invoice.Code to retrieve invoice info.

Transaction errors

In addition to the Errors property in the recurly.Response, response also contains a TransactionError field for Transaction Errors.

Be sure to check resp.TransactionError for any API calls that may return a transaction error for additional info. The TransactionError struct is defined like this:

TransactionError struct {
    XMLName          xml.Name `xml:"transaction_error"`
    ErrorCode        string   `xml:"error_code,omitempty"`
    ErrorCategory    string   `xml:"error_category,omitempty"`
    MerchantMessage  string   `xml:"merchant_message,omitempty"`
    CustomerMessage  string   `xml:"customer_message,omitempty"`
    GatewayErrorCode string   `xml:"gateway_error_code,omitempty"`
}

Link to transaction error documentation.

Using webhooks

Initial webhook support is in place. The following webhooks are supported:

  • SuccessfulPaymentNotification
  • FailedPaymentNotification
  • PastDueInvoiceNotification

Webhooks can be used by passing an io.Reader to webhooks.Parse, then using a switch statement with type assertions to determine the webhook returned.

PRs are welcome for additional webhooks.

License

recurly is available under the MIT License.