{"__v":2,"_id":"578e7c59b434c30e0035bf36","api":{"auth":"required","params":[],"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","url":""},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"API Authentication (HTTP Basic)\"\n}\n[/block]\nRecurly uses HTTP Basic Authentication—your [Private API key](https://app.recurly.com/go/developer/api_access) is securely encrypted by the SSL channel.\n\nIf you are testing the API calls via the command line with cURL, try:\n\n```\ncurl -H 'Accept: application/xml' \\\n     -H 'X-Api-Version: 2.3' \\\n     -H 'Content-Type: application/xml; charset=utf-8' \\\n     -u '[apikey]:' \\\n    https://[subdomain].recurly.com/v2/accounts\n```\n\nReplace `[apikey]` and `[subdomain]` with the appropriate values for your site.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Calculating your own authorization header\"\n}\n[/block]\nMost programming languages encode the authorization header automatically. With HTTP Basic Authentication, the `Authorization` header is a string containing a Base-64 encoded username and password. In the case of Recurly’s API, you need only specify the username as your API key. If your library requires a password, set it to an empty string.\n\n```\n\"Authorization\": \"Basic \" + base64_encode(API Key)\n```\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Additional Request Headers\"\n}\n[/block]\n## Accept Header\nRecurly API v2 returns results as XML. Your requests should always include the header requesting the results as XML:\n\n```\nAccept: application/xml\n```\n\n## Content-Type Header\nWhen sending data to Recurly in a POST or PUT request, your request must specify the content type of your request:\n\n```\nContent-Type: application/xml; charset=utf-8\n```\n\n## X-Api-Version Header\nWhen sending data to Recurly, your request should specify the API version you're attempting to interact with:\n```\nX-Api-Version: 2.3\n```\nYou learn more about the different versions in the [API Versioning](doc:versioning) section.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Acceptable API versions\",\n  \"body\": \"Recurly supports the following API versions: **[2.0](https://dev.recurly.com/v2.0/docs)**, **[2.1](https://dev.recurly.com/v2.1/docs)**, **[2.2](https://dev.recurly.com/v2.2/docs)**, **[2.3](https://dev.recurly.com/v2.3/docs)**\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Public API Key\"\n}\n[/block]\nRecurly uses to types of API keys: public and private. The Public API key is used by [Recurly.js](doc:recurlyjs) to identify its requests as belonging to your Recurly site. This key can be safely included in Javascript code.\n\nRecurly provides each site with one Public Key. The Public API Key can be regenerated on the [API Credentials](https://app.recurly.com/go/developer/api_access) page.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Private API Keys\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Treat your Private API Keys like passwords!\",\n  \"body\": \"The API key allows access to your site's data. Do not include it in Javascript code exposed to browsers.\"\n}\n[/block]\nRecurly supports the use of multiple Private API keys, which can be used to integrate third party services using unique, controlled credentials.\n\n## Limits & Pricing\nMerchants on the Core or grandfathered Recurly plans or merchants in sandbox mode will be granted 5 private API keys. Merchants on Recurly’s Professional plan will be granted 10 private API keys.\n\n## Default Key\nYour default private API key should be used to integrate Recurly with your backend systems. There will be at least one key active at all times.\n\n## Additional Keys\nAdditional private API keys should be used to connect your Recurly data to additional sources, like analytics software, accounting packages, or email tools. Recurly recommends clearly labeling the name of each key to identify the associated vendor.\n\n## Regenerating Private API Keys\nYour API key can be regenerated by clicking on the Regenerate button on the [API credentials](https://app.recurly.com/go/developer/api_access) page. When you generate a private API key, you have two options:\n\n1. Block the old key immediately. This is primarily recommended when the security of a key has been compromised.\n2. Allow the old key access for 12 hours. This is primarily used when updating systems and a smooth transition between keys is needed.\n\n*If a private API key is changed, an email alert will be sent to your Recurly Site Technical Contact.*\n\n## Read-Only Keys\nWhen creating a private key, you will have the option to set the key to “read-only”. This means the API key may make GET requests but cannot not PUT, POST or DELETE requests.","category":"578e7c59b434c30e0035bf26","createdAt":"2015-06-10T22:06:37.745Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"getting-started","sync_unique":"","title":"Authentication","type":"basic","updates":["5595c7e9f44370190028891c","562aa244ed4bea0d00c11d8b","56bb4e10dabd992100b674f7","56f19a949791b22d0077ba0f","57bb2dfc5c849b1700f1e545"],"user":"5564a0073a61a72f0067cb22","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

Authentication


API Authentication (HTTP Basic)

Recurly uses HTTP Basic Authentication—your Private API key is securely encrypted by the SSL channel.

If you are testing the API calls via the command line with cURL, try:

curl -H 'Accept: application/xml' \
     -H 'X-Api-Version: 2.3' \
     -H 'Content-Type: application/xml; charset=utf-8' \
     -u '[apikey]:' \
    https://[subdomain].recurly.com/v2/accounts

Replace [apikey] and [subdomain] with the appropriate values for your site.

Calculating your own authorization header

Most programming languages encode the authorization header automatically. With HTTP Basic Authentication, the Authorization header is a string containing a Base-64 encoded username and password. In the case of Recurly’s API, you need only specify the username as your API key. If your library requires a password, set it to an empty string.

"Authorization": "Basic " + base64_encode(API Key)

Additional Request Headers

Accept Header

Recurly API v2 returns results as XML. Your requests should always include the header requesting the results as XML:

Accept: application/xml

Content-Type Header

When sending data to Recurly in a POST or PUT request, your request must specify the content type of your request:

Content-Type: application/xml; charset=utf-8

X-Api-Version Header

When sending data to Recurly, your request should specify the API version you're attempting to interact with:

X-Api-Version: 2.3

You learn more about the different versions in the API Versioning section.

Acceptable API versions

Recurly supports the following API versions: 2.0, 2.1, 2.2, 2.3

Public API Key

Recurly uses to types of API keys: public and private. The Public API key is used by Recurly.js to identify its requests as belonging to your Recurly site. This key can be safely included in Javascript code.

Recurly provides each site with one Public Key. The Public API Key can be regenerated on the API Credentials page.

Private API Keys

Treat your Private API Keys like passwords!

The API key allows access to your site's data. Do not include it in Javascript code exposed to browsers.

Recurly supports the use of multiple Private API keys, which can be used to integrate third party services using unique, controlled credentials.

Limits & Pricing

Merchants on the Core or grandfathered Recurly plans or merchants in sandbox mode will be granted 5 private API keys. Merchants on Recurly’s Professional plan will be granted 10 private API keys.

Default Key

Your default private API key should be used to integrate Recurly with your backend systems. There will be at least one key active at all times.

Additional Keys

Additional private API keys should be used to connect your Recurly data to additional sources, like analytics software, accounting packages, or email tools. Recurly recommends clearly labeling the name of each key to identify the associated vendor.

Regenerating Private API Keys

Your API key can be regenerated by clicking on the Regenerate button on the API credentials page. When you generate a private API key, you have two options:

  1. Block the old key immediately. This is primarily recommended when the security of a key has been compromised.
  2. Allow the old key access for 12 hours. This is primarily used when updating systems and a smooth transition between keys is needed.

If a private API key is changed, an email alert will be sent to your Recurly Site Technical Contact.

Read-Only Keys

When creating a private key, you will have the option to set the key to “read-only”. This means the API key may make GET requests but cannot not PUT, POST or DELETE requests.

View all 92 endpoints
{"__v":3,"_id":"578e7c59b434c30e0035bf37","api":{"auth":"required","params":[],"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","url":""},"body":"Recurly strives to provide developers with stable APIs to integrate against while still being able to provide new and expanded functionality. To balance these two goals we provide different API versions and only add new features to the latest version of the API. This allows you to choose the best time to update your integration and take advantage of new features.\n\nRecurly offers the following API versions: [2.3](https://dev.recurly.com/v2.3/docs), [2.2](https://dev.recurly.com/v2.2/docs), [2.1](https://dev.recurly.com/v2.1/docs), [2.0](https://dev.recurly.com/v2.0/docs).\n\n## Requesting A Version\n\nWhen making requests to Recurly, your request should specify the desired API version using the `X-Api-Version` header:\n```\nX-Api-Version: 2.3\n```\nFor backwards compatibility, if no version is specified the default is 2.0.\n\n## Deprecation\n\nTo signal that an API version is deprecated and will be removed in the future, Recurly will respond the following headers:\n```\nRecurly-Deprecated: TRUE\nRecurly-Sunset-Date: 2018-06-01T00:00:00+00:00\n```\nThe sunset date is an ISO 8601 date time when the version will no longer be accessible.\n\nYour integration should check for those headers so you can make updates in a timely fashion.\n\n## Changes in v2.3\n\nThis release added:\n\n* Revenue schedules to several objects to enable Revenue Recognition.\n* Sorting and date filtering to listing endpoints, see [Pagination](doc:pagination) for details.\n* The ability to check an account's balance, see [Lookup Account Balance](doc:lookup-account-balance) for details.\n\nDetailed listing of changes to requests and responses:\n\n- Changed Account response:\n  - Added `<account_balance>` link element.\n- Changed Adjustment response:\n  - Added `<revenue_schedule_type>` element.\n- Changed Plan response:\n  - Added `<revenue_schedule_type>` element.\n  - Added `<setup_fee_revenue_schedule_type>` element.\n- Changed Plan Add-On response:\n  - Added `<revenue_schedule_type>` element.\n- Changed Subscription response:\n  - Added `<revenue_schedule_type>` element.\n - Changed Subscription Add-On response:\n  - Added `<revenue_schedule_type>` element.\n- Changed Transaction response:\n  - Added `<original_transaction>` link element.\n- Added pagination options:\n  - Added `sort` option: accepts `created_at`/`updated_at`, defaults to `created_at`.\n  - Added `order` option: accepts `desc`/`asc`, defaults to `desc`.\n  - Added `begin_time`/`end_time` options: accepts an ISO 8601 date or date and time.\n\nA complete list of changes for all versions is available on the [API Release Notes](https://dev.recurly.com/page/api-release-notes) page.","category":"578e7c59b434c30e0035bf26","createdAt":"2016-07-18T22:26:12.882Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"versioning","sync_unique":"","title":"API Versioning","type":"basic","updates":[],"user":"559d85d26b21311700fb0b7b","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

API Versioning


Recurly strives to provide developers with stable APIs to integrate against while still being able to provide new and expanded functionality. To balance these two goals we provide different API versions and only add new features to the latest version of the API. This allows you to choose the best time to update your integration and take advantage of new features.

Recurly offers the following API versions: 2.3, 2.2, 2.1, 2.0.

Requesting A Version

When making requests to Recurly, your request should specify the desired API version using the X-Api-Version header:

X-Api-Version: 2.3

For backwards compatibility, if no version is specified the default is 2.0.

Deprecation

To signal that an API version is deprecated and will be removed in the future, Recurly will respond the following headers:

Recurly-Deprecated: TRUE
Recurly-Sunset-Date: 2018-06-01T00:00:00+00:00

The sunset date is an ISO 8601 date time when the version will no longer be accessible.

Your integration should check for those headers so you can make updates in a timely fashion.

Changes in v2.3

This release added:

  • Revenue schedules to several objects to enable Revenue Recognition.
  • Sorting and date filtering to listing endpoints, see Pagination for details.
  • The ability to check an account's balance, see Lookup Account Balance for details.

Detailed listing of changes to requests and responses:

  • Changed Account response:
    • Added <account_balance> link element.
  • Changed Adjustment response:
    • Added <revenue_schedule_type> element.
  • Changed Plan response:
    • Added <revenue_schedule_type> element.
    • Added <setup_fee_revenue_schedule_type> element.
  • Changed Plan Add-On response:
    • Added <revenue_schedule_type> element.
  • Changed Subscription response:
    • Added <revenue_schedule_type> element.
    • Changed Subscription Add-On response:
    • Added <revenue_schedule_type> element.
  • Changed Transaction response:
    • Added <original_transaction> link element.
  • Added pagination options:
    • Added sort option: accepts created_at/updated_at, defaults to created_at.
    • Added order option: accepts desc/asc, defaults to desc.
    • Added begin_time/end_time options: accepts an ISO 8601 date or date and time.

A complete list of changes for all versions is available on the API Release Notes page.

{"__v":8,"_id":"578e7c59b434c30e0035bf38","api":{"auth":"required","params":[],"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","url":""},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Number of Records\"\n}\n[/block]\nEndpoints that return a list of resources will include a header indicating the total number of records available. This is specified with the `X-Records` header. E.g., for an endpoint with 14 records:\n\n```\nX-Records: 14\n```\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Next Link\"\n}\n[/block]\nThe amount of records returns within a single API request defaults to 50. It may be changed to a maximum of 200 using a `per_page` query parameter, e.g. to return 200 accounts at a time:\n\n```\nhttps://your-subdomain.recurly.com/v2/accounts?per_page=200\n```\n\nWhen there are more records remaining than fit in the current response, the `Link` header is specified with the URI to the next page of results.\n\n```\nStatus: 200 OK \nX-Records: 204 \nLink: <https://your-subdomain.recurly.com/v2/accounts?cursor=1972702718353176814%3A1465932489>; rel=\"next\" \nETag: \"a4b0568a2278bc591ceb64b31547eb78\" \n```\n\nThe `cursor` parameter is a time-based pointer indicating where to resume the results. By using a cursor instead of page numbers, the API avoids returning duplicate records in the case where additional resources are added between pagination requests.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Sorting and Filtering\"\n}\n[/block]\n Many endpoints support these advanced pagination parameters:\n\n* `sort` : String: The attribute that will be used to order records: `created_at`, `updated_at`. Defaults to `created_at`.\n* `order` : String : The order in which products will be returned: `asc` for ascending order, `desc` for descending order. Defaults to `desc`.\n* `begin_time` : Datetime : Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes greater than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.\n* `end_time` : Datetime : Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes less than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.\n\nReview the parameters on each endpoint for more details.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"An account that was updated on `2016-01-19` and then again on `2016-03-23` would not be returned in a request for `sort=updated_at&end_time=2016-03-01`.\",\n  \"title\": \"Updated at really means last updated at\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples\"\n}\n[/block]\nThis will return accounts that were created on or before 2016-01-01 0:00 UTC in descending order of creation date:\n```\nhttps://your-subdomain.recurly.com/v2/accounts?sort=created_at&order=desc&end_time=2016-01-01\n```\n\nThis will return accounts that were last updated on or after 2016-07-01 10:30:01 Mountain Daylight Time in ascending order of updated date:\n\n```\nhttps://your-subdomain.recurly.com/v2/accounts?sort=updated_at&order=asc&begin_time=2016-07-01T10:30:01-06:00\n```\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"It's important to be aware that when paging through records sorted by their `updated_at` value, the order will change if they are modified:\\n* In ascending order, changes to records in previous pages will cause them to move back the end of the list, meaning you may see them multiple times. This can be avoided by using the time the pagination starts as the `end_time`.\\n* In descending order, changes to records in later pages will cause them to move up to the beginning of the list, meaning you would miss results.\",\n  \"title\": \"Beware of changes to records when sorting by updated_at\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?php\\n// When accessing a sub resource with a many-to-one relation\\n// to the parent model, the attribute returns a Recurly_Stub.\\n// For example, take Account -> Invoices\\n\\n$account = Recurly_Account::get('my_account_code');\\n\\n// Calling ->invoices returns a Stub which allows lazily loading the list\\n$invoices = $account->invoices;\\n\\nprint $invoices;\\n// => <Recurly_Stub[invoices] href=https://api.recurly.com/v2/accounts/my_account_code/invoices>\\n\\n/**\\n * Prior to 2.5.0 calling ->get() would only return the first page\\n * of results. With 2.5.0 and later, all results will be returned.\\n */\\nforeach ($invoices->get() as $inv) {\\n   print $inv->invoice_number . \\\"\\\\n\\\";\\n}\\n\\n/**\\n * Creating a List object directly will also allow you to iterate\\n * through all pages\\n */\\n$invoices = Recurly_InvoiceList::getForAccount('my_account_code');\\n\\n// Prints all invoices on the account\\nforeach ($invoices as $inv) {\\n   print $inv->invoice_number . \\\"\\\\n\\\";\\n}\\n\",\n      \"language\": \"php\",\n      \"gist\": \"44632c432dce4f56a0fa\"\n    },\n    {\n      \"code\": \"# When accessing a sub resource with a many-to-one relation \\n# to the parent model, the attribute returns a Recurly::Resource::Pager. \\n# For example, take Account -> Invoices\\n\\naccount = Recurly::Account.find('my_account_code')\\n\\nputs account.invoices.class\\n#=> Recurly::Resource::Pager\\n\\n# Pager#each can be used to iterate through the only the given page\\naccount.invoices.each do |invoice|\\n  puts invoice.invoice_number\\nend\\n\\n# The default page size is 50 items, if you wish to page through more\\n# you can use Pager#find_each, find_each continues to fetch pages until\\n# there are none left\\naccount.invoices.find_each do |invoice|\\n  puts invoice.invoice_number\\nend\\n\\n# You can also create a Pager directly from a resource\\nputs Recurly::Invoice.paginate.class\\n#=> Recurly::Resource::Pager\\n\\n# paginate takes options\\nRecurly::Invoice.paginate(per_page: 10).each do |invoice|\\n  puts invoice.invoice_number\\nend\\n\\n# You can also use #find_each directly on the resource\\nRecurly::Invoice.find_each(per_page: 10).each do |invoice|\\n  puts invoice.invoice_number\\nend\\n\",\n      \"language\": \"ruby\"\n    },\n    {\n      \"code\": \"# When accessing a sub resource with a many-to-one relation\\n# to the parent model, the attribute returns a `relatiator` function.\\n# When called it returns a recurly.resource.Page.\\n# For example, take Account -> Invoices\\n\\naccount = recurly.Account.get('tester')\\n\\nprint account.invoices\\n# => <function relatitator at 0x1023628c0>\\n\\nprint account.invoices().__class__\\n# => <class 'recurly.resource.Page'>\\n\\n# To page through every invoice on the account\\nfor invoice in account.invoices():\\n    print invoice.invoice_number\\n\\n# You can also call the all() method on\\n# a resource to page through every resource\\n# on your site. For instance, to page through\\n# every invoice:\\nfor invoice in recurly.Invoice.all():\\n    print invoice.invoice_number\",\n      \"language\": \"python\",\n      \"name\": null\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"The PHP `Recurly_Pager` class sets up an iterator across all the relevant records. It does not provide pagination functionality by default.\",\n  \"title\": \"PHP Pagination\"\n}\n[/block]","category":"578e7c59b434c30e0035bf26","createdAt":"2015-06-15T22:48:39.567Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"pagination","sync_unique":"","title":"Pagination","type":"basic","updates":[],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

Pagination


Number of Records

Endpoints that return a list of resources will include a header indicating the total number of records available. This is specified with the X-Records header. E.g., for an endpoint with 14 records:

X-Records: 14

Next Link

The amount of records returns within a single API request defaults to 50. It may be changed to a maximum of 200 using a per_page query parameter, e.g. to return 200 accounts at a time:

https://your-subdomain.recurly.com/v2/accounts?per_page=200

When there are more records remaining than fit in the current response, the Link header is specified with the URI to the next page of results.

Status: 200 OK 
X-Records: 204 
Link: <https://your-subdomain.recurly.com/v2/accounts?cursor=1972702718353176814%3A1465932489>; rel="next" 
ETag: "a4b0568a2278bc591ceb64b31547eb78"

The cursor parameter is a time-based pointer indicating where to resume the results. By using a cursor instead of page numbers, the API avoids returning duplicate records in the case where additional resources are added between pagination requests.

Sorting and Filtering

Many endpoints support these advanced pagination parameters:

  • sort : String: The attribute that will be used to order records: created_at, updated_at. Defaults to created_at.
  • order : String : The order in which products will be returned: asc for ascending order, desc for descending order. Defaults to desc.
  • begin_time : Datetime : Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes greater than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.
  • end_time : Datetime : Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes less than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.

Review the parameters on each endpoint for more details.

Updated at really means last updated at

An account that was updated on 2016-01-19 and then again on 2016-03-23 would not be returned in a request for sort=updated_at&end_time=2016-03-01.

Examples

This will return accounts that were created on or before 2016-01-01 0:00 UTC in descending order of creation date:

https://your-subdomain.recurly.com/v2/accounts?sort=created_at&order=desc&end_time=2016-01-01

This will return accounts that were last updated on or after 2016-07-01 10:30:01 Mountain Daylight Time in ascending order of updated date:

https://your-subdomain.recurly.com/v2/accounts?sort=updated_at&order=asc&begin_time=2016-07-01T10:30:01-06:00

Beware of changes to records when sorting by updated_at

It's important to be aware that when paging through records sorted by their updated_at value, the order will change if they are modified:

  • In ascending order, changes to records in previous pages will cause them to move back the end of the list, meaning you may see them multiple times. This can be avoided by using the time the pagination starts as the end_time.
  • In descending order, changes to records in later pages will cause them to move up to the beginning of the list, meaning you would miss results.
<?php
// When accessing a sub resource with a many-to-one relation
// to the parent model, the attribute returns a Recurly_Stub.
// For example, take Account -> Invoices

$account = Recurly_Account::get('my_account_code');

// Calling ->invoices returns a Stub which allows lazily loading the list
$invoices = $account->invoices;

print $invoices;
// => <Recurly_Stub[invoices] href=https://api.recurly.com/v2/accounts/my_account_code/invoices>

/**
 * Prior to 2.5.0 calling ->get() would only return the first page
 * of results. With 2.5.0 and later, all results will be returned.
 */
foreach ($invoices->get() as $inv) {
   print $inv->invoice_number . "\n";
}

/**
 * Creating a List object directly will also allow you to iterate
 * through all pages
 */
$invoices = Recurly_InvoiceList::getForAccount('my_account_code');

// Prints all invoices on the account
foreach ($invoices as $inv) {
   print $inv->invoice_number . "\n";
}
# When accessing a sub resource with a many-to-one relation 
# to the parent model, the attribute returns a Recurly::Resource::Pager. 
# For example, take Account -> Invoices

account = Recurly::Account.find('my_account_code')

puts account.invoices.class
#=> Recurly::Resource::Pager

# Pager#each can be used to iterate through the only the given page
account.invoices.each do |invoice|
  puts invoice.invoice_number
end

# The default page size is 50 items, if you wish to page through more
# you can use Pager#find_each, find_each continues to fetch pages until
# there are none left
account.invoices.find_each do |invoice|
  puts invoice.invoice_number
end

# You can also create a Pager directly from a resource
puts Recurly::Invoice.paginate.class
#=> Recurly::Resource::Pager

# paginate takes options
Recurly::Invoice.paginate(per_page: 10).each do |invoice|
  puts invoice.invoice_number
end

# You can also use #find_each directly on the resource
Recurly::Invoice.find_each(per_page: 10).each do |invoice|
  puts invoice.invoice_number
end
# When accessing a sub resource with a many-to-one relation
# to the parent model, the attribute returns a `relatiator` function.
# When called it returns a recurly.resource.Page.
# For example, take Account -> Invoices

account = recurly.Account.get('tester')

print account.invoices
# => <function relatitator at 0x1023628c0>

print account.invoices().__class__
# => <class 'recurly.resource.Page'>

# To page through every invoice on the account
for invoice in account.invoices():
    print invoice.invoice_number

# You can also call the all() method on
# a resource to page through every resource
# on your site. For instance, to page through
# every invoice:
for invoice in recurly.Invoice.all():
    print invoice.invoice_number

PHP Pagination

The PHP Recurly_Pager class sets up an iterator across all the relevant records. It does not provide pagination functionality by default.

{"__v":0,"_id":"578e7c59b434c30e0035bf39","api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"body":"In order to provide a fast response time to all our customers, we may rate limit excessive requests. By default, new Recurly sites have the following API rate limits:\n\n* Sandbox sites: 400 requests/min. All requests count towards the rate limit.\n* Production sites: 1,000 requests/min. Only GET requests count towards the rate limit.\n\nOnce your site moves into production mode, Recurly will only rate limit GET requests. New subscriptions, account modifications, and other requests using POST, PUT, or DELETE methods will not count against your rate limit.\n\nThe rate limit is calculated over a sliding 5 minute window. This means a production site could make 4,000 requests within one minute and not hit the rate limit so long as the site made less than 1,000 requests during the prior 4 minutes.\n\nIf an API request exceeds the rate limit, the API returns a 429 status code indicating `Too Many Requests`. If your business needs a higher limit, please contact support.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"HTTP Headers\"\n}\n[/block]\nEvery authenticated API request returns headers with your current rate limit information. Your requests’ rate limit headers may look like:\n\n```\nX-RateLimit-Limit: 5000\nX-RateLimit-Remaining: 4999\nX-RateLimit-Reset: 1414622019\n```\n\nThe `X-RateLimit-Limit` is your total request limit during the 5 minute window (e.g. requests/min * 5 min). The `X-RateLimit-Remaining` indicates the number of requests remaining until your requests will be denied. Finally, the `X-RateLimit-Reset` header contains a timestamp for when the current window will completely reset assuming no further API requests are made.","category":"578e7c59b434c30e0035bf26","createdAt":"2015-06-15T22:49:59.038Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"rate-limits","sync_unique":"","title":"Rate Limits","type":"basic","updates":[],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

Rate Limits


In order to provide a fast response time to all our customers, we may rate limit excessive requests. By default, new Recurly sites have the following API rate limits:

  • Sandbox sites: 400 requests/min. All requests count towards the rate limit.
  • Production sites: 1,000 requests/min. Only GET requests count towards the rate limit.

Once your site moves into production mode, Recurly will only rate limit GET requests. New subscriptions, account modifications, and other requests using POST, PUT, or DELETE methods will not count against your rate limit.

The rate limit is calculated over a sliding 5 minute window. This means a production site could make 4,000 requests within one minute and not hit the rate limit so long as the site made less than 1,000 requests during the prior 4 minutes.

If an API request exceeds the rate limit, the API returns a 429 status code indicating Too Many Requests. If your business needs a higher limit, please contact support.

HTTP Headers

Every authenticated API request returns headers with your current rate limit information. Your requests’ rate limit headers may look like:

X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999
X-RateLimit-Reset: 1414622019

The X-RateLimit-Limit is your total request limit during the 5 minute window (e.g. requests/min * 5 min). The X-RateLimit-Remaining indicates the number of requests remaining until your requests will be denied. Finally, the X-RateLimit-Reset header contains a timestamp for when the current window will completely reset assuming no further API requests are made.

{"__v":0,"_id":"578e7c59b434c30e0035bf3a","api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"body":"## SUCCESSFUL STATUS CODES (2XX)\n`200 OK`\nThe request was successful.\n`201 Created`\nThe resource was successfully created. Confirms a success when creating a new account, credit, subscription, etc.\n`204 No Content`\nThe request was successful and there is no response body.\n\n## CLIENT ERROR STATUS CODES (4XX)\n`400 Bad Request`\nThe request was invalid or could not be understood by the server. Resubmitting the request will likely result in the same error. This commonly occurs when your XML is invalid, e.g. ampersands are not correctly encoded in the text of your request. Please inspect the body of the response for more details regarding the error.\n`401 Unauthorized`\nYour API key is missing or invalid.\n`402 Payment Required`\nYour Recurly account is in production mode but is not in good standing. Please pay any outstanding invoices.\n`403 Forbidden`\nThe login is attempting to perform an action it does not have privileges to access. Verify your login credentials are for the appropriate account.\n`404 Not Found`\nThe resource was not found with the given identifier. The response body will explain which resource was not found.\n`405 Method Not Allowed`\nThe requested method is not valid at the given URL.\n`406 Not Acceptable`\nThe request's Accept header is not set to application/xml.\n`412 Precondition Failed`\nThe request was unsuccessful because a condition was not met. For example, this message may be returned if you attempt to cancel a subscription for an account that has no subscription.\n`422 Unprocessable Entity`\nCould not process a POST or PUT request because the request is invalid. See the response body for more details.\n`429 Too many Requests`\nYou have made too many API requests in the last hour. Future API requests will be ignored until the beginning of the next hour.\n\n## SERVER ERROR STATUS CODES (5XX)\n`500 Internal Server Error`\nThe server encountered an error while processing your request and failed.\n`502 Gateway Error`\nThe load balancer or web server has trouble connecting to the Recurly app. Please try the request again.\n`503 Service Unavailable`\nThe service is temporarily unavailable. Please try the request again.\n\n##FUTURE COMPATIBILITY\nFor future compatibility, please interpret the following status code ranges:\n\n**200–299** as success,\n**400–499** as client request errors,\n**500–599** as server errors\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"404 Not Found Responses\"\n}\n[/block]\nWhen a lookup, update, or delete request is requested on an object that does not exist, the server returns `404 Not Found`:\n\n```\nStatus: 404 Not Found\nContent-Type: application/xml; charset=utf-8\n```\n\n```\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<error>\n  <symbol>not_found</symbol>\n  <description>The record could not be located.</description>\n</error>\n```\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"422 Unprocessable Entity Responses\"\n}\n[/block]\nIf the requested create, update, or delete cannot be performed due to validation errors, the server returns a `422 Unprocessable Entity` response with an array of the validation errors:\n\n```\nStatus: 422 Unprocessable Entity\nContent-Type: application/xml; charset=utf-8\n```\n\n```\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error field=\"model_name.field_name\" symbol=\"not_a_number\" lang=\"en-US\">is not a number</error>\n</errors>\n```","category":"578e7c59b434c30e0035bf26","createdAt":"2015-06-10T22:06:26.211Z","excerpt":"Every request includes an HTTP status code with the result. The status code should examined before the response. In most error cases, the response body will contain an errors XML document with more details.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"welcome","sync_unique":"","title":"HTTP Status Codes","type":"basic","updates":["56cd46e949abf10b0036a1e6"],"user":"5564a0073a61a72f0067cb22","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

HTTP Status Codes

Every request includes an HTTP status code with the result. The status code should examined before the response. In most error cases, the response body will contain an errors XML document with more details.

SUCCESSFUL STATUS CODES (2XX)

200 OK
The request was successful.
201 Created
The resource was successfully created. Confirms a success when creating a new account, credit, subscription, etc.
204 No Content
The request was successful and there is no response body.

CLIENT ERROR STATUS CODES (4XX)

400 Bad Request
The request was invalid or could not be understood by the server. Resubmitting the request will likely result in the same error. This commonly occurs when your XML is invalid, e.g. ampersands are not correctly encoded in the text of your request. Please inspect the body of the response for more details regarding the error.
401 Unauthorized
Your API key is missing or invalid.
402 Payment Required
Your Recurly account is in production mode but is not in good standing. Please pay any outstanding invoices.
403 Forbidden
The login is attempting to perform an action it does not have privileges to access. Verify your login credentials are for the appropriate account.
404 Not Found
The resource was not found with the given identifier. The response body will explain which resource was not found.
405 Method Not Allowed
The requested method is not valid at the given URL.
406 Not Acceptable
The request's Accept header is not set to application/xml.
412 Precondition Failed
The request was unsuccessful because a condition was not met. For example, this message may be returned if you attempt to cancel a subscription for an account that has no subscription.
422 Unprocessable Entity
Could not process a POST or PUT request because the request is invalid. See the response body for more details.
429 Too many Requests
You have made too many API requests in the last hour. Future API requests will be ignored until the beginning of the next hour.

SERVER ERROR STATUS CODES (5XX)

500 Internal Server Error
The server encountered an error while processing your request and failed.
502 Gateway Error
The load balancer or web server has trouble connecting to the Recurly app. Please try the request again.
503 Service Unavailable
The service is temporarily unavailable. Please try the request again.

FUTURE COMPATIBILITY

For future compatibility, please interpret the following status code ranges:

200–299 as success,
400–499 as client request errors,
500–599 as server errors

404 Not Found Responses

When a lookup, update, or delete request is requested on an object that does not exist, the server returns 404 Not Found:

Status: 404 Not Found
Content-Type: application/xml; charset=utf-8
<?xml version="1.0" encoding="UTF-8"?>
<error>
  <symbol>not_found</symbol>
  <description>The record could not be located.</description>
</error>

422 Unprocessable Entity Responses

If the requested create, update, or delete cannot be performed due to validation errors, the server returns a 422 Unprocessable Entity response with an array of the validation errors:

Status: 422 Unprocessable Entity
Content-Type: application/xml; charset=utf-8
<?xml version="1.0" encoding="UTF-8"?>
<errors>
  <error field="model_name.field_name" symbol="not_a_number" lang="en-US">is not a number</error>
</errors>
{"__v":0,"_id":"578e7c5ab434c30e0035bfa2","api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"body":"Recurly has a variety of integrations you should check out!\n\n[Webhooks API](https://dev.recurly.com/page/webhooks)\n\n[Customer Imports](https://dev.recurly.com/page/customer-imports)","category":"578e7c59b434c30e0035bf27","createdAt":"2015-06-26T18:21:30.595Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"integrations","sync_unique":"","title":"Integrations","type":"basic","updates":[],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

Integrations


Recurly has a variety of integrations you should check out!

Webhooks API

Customer Imports

{"__v":0,"_id":"578e7c59b434c30e0035bf54","api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"body":"Recurly has a variety of official client libraries you should check out!\n\n[PHP](https://dev.recurly.com/page/php)\n[Ruby](https://dev.recurly.com/page/ruby)\n[Python](https://dev.recurly.com/page/python)\n[.Net](https://dev.recurly.com/page/net)\niOS – [Github](https://github.com/recurly/recurly-client-ios) | [Documentation](http://cocoadocs.org/docsets/RecurlySDK/)\n[Android](https://github.com/recurly/recurly-client-android)\n\nThere are also some unofficial libraries created by our users\n\n[Java](https://github.com/killbilling/recurly-java-library)\n[GO](https://github.com/cgerrior/gorecurly)\n[Node.js](https://github.com/cgerrior/node-recurly)","category":"578e7c59b434c30e0035bf28","createdAt":"2015-06-26T18:25:56.960Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"client-libraries","sync_unique":"","title":"Client Libraries","type":"basic","updates":["55940e20fd29b92300c262bf","55b2bfc0a74a380d00e290a6","55b2c0466862a10d00887adf","55bbb926a8400c2d00873f2a","565f689e413e06170093df6a"],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

Client Libraries


Recurly has a variety of official client libraries you should check out!

PHP
Ruby
Python
.Net
iOS – Github | Documentation
Android

There are also some unofficial libraries created by our users

Java
GO
Node.js

{"__v":0,"_id":"578e7c5ab434c30e0035bf84","api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"body":"<img src=\"https://files.readme.io/kBrV8yRSzOKtvARQyP46_RecurlyJS_Logo-594.png\" alt=\"Recurly.js Logo\" width=\"300\">\n\n<h3>Customize Your Checkout Process and Accept Payments Securely</h3>\n\nSecurely accept sensitive payment details within your checkout process with a fully customizable user experience. The Recurly.js JavaScript library secures your checkout forms. Create subscriptions, process one-time transactions, and update customer billing information worry-free.\n\n<h3>PCI Compliance through Hosted Fields</h3>\n\nRecurly provides transparent iframes that allow you to deliver a customized customer checkout experience, while ensuring you meet the latest PCI DSS SAQ A compliance requirements.","category":"578e7c59b434c30e0035bf29","createdAt":"2016-03-04T22:51:11.649Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"recurlyjs","sync_unique":"","title":"Recurly.js Overview","type":"basic","updates":[],"user":"5564a0073a61a72f0067cb22","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

Recurly.js Overview


Recurly.js Logo

Customize Your Checkout Process and Accept Payments Securely

Securely accept sensitive payment details within your checkout process with a fully customizable user experience. The Recurly.js JavaScript library secures your checkout forms. Create subscriptions, process one-time transactions, and update customer billing information worry-free.

PCI Compliance through Hosted Fields

Recurly provides transparent iframes that allow you to deliver a customized customer checkout experience, while ensuring you meet the latest PCI DSS SAQ A compliance requirements.

{"__v":0,"_id":"578e7c5ab434c30e0035bf85","api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"body":"When a customer submits your payment form, Recurly.js sends customer payment information to be encrypted and stored at Recurly and gives you an authorization key to complete the subscription process using our API.\n\nWith this authorization key (or *token*), you can do anything with our API that requires payment information. Because you never handle any sensitive payment information, your PCI scope is drastically reduced.","category":"578e7c59b434c30e0035bf29","createdAt":"2016-03-01T03:19:34.724Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"how-it-works","sync_unique":"","title":"How it Works","type":"basic","updates":["570eb5f23160d10e0041df28"],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

How it Works


When a customer submits your payment form, Recurly.js sends customer payment information to be encrypted and stored at Recurly and gives you an authorization key to complete the subscription process using our API.

With this authorization key (or token), you can do anything with our API that requires payment information. Because you never handle any sensitive payment information, your PCI scope is drastically reduced.

{"__v":3,"_id":"578e7c5ab434c30e0035bf86","api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"body":"## Include\n\n`<script src=\"https://js.recurly.com/v4/recurly.js\"></script>`\n\nTo begin, you'll include the Recurly.js script on your page.\n\nThis exposes a single global object, `recurly`.\n\n## Configure\n\n`recurly.configure('sc-ABCDEFGHI123456789');`\n\nSimply call `recurly.configure` anywhere on your page, passing your public key. This identifies your site to Recurly servers. You can find your public key in the [API Access section](https://app.recurly.com/go/developer/api_access) of your admin app.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Be sure to replace `sc-ABCDEFGHI123456789` with your own public key.\",\n  \"title\": \"\"\n}\n[/block]\n`recurly.configure` accepts other options not detailed here. You may refer to the [source](https://github.com/recurly/recurly-js/blob/master/lib/recurly.js#L84-L143) for more detail.\n\n## Build a Card form\n\nBuild a form however you like. Use the data-recurly attribute to identify input field targets to Recurly.js. To identify where Recurly.js will inject card data fields, we recommend using simple div elements.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<form>\\n  <input type=\\\"text\\\" data-recurly=\\\"first_name\\\">\\n  <input type=\\\"text\\\" data-recurly=\\\"last_name\\\">\\n  <div data-recurly=\\\"number\\\"></div>\\n  <div data-recurly=\\\"month\\\"></div>\\n  <div data-recurly=\\\"year\\\"></div>\\n  <div data-recurly=\\\"cvv\\\"></div>\\n  <input type=\\\"hidden\\\" name=\\\"recurly-token\\\" data-recurly=\\\"token\\\">\\n  <button>submit</button>\\n</form>\",\n      \"language\": \"html\"\n    }\n  ]\n}\n[/block]\nTo collect card payment information from your customers, you'll create a form similar to this one. Recurly.js uses the `data-recurly` attributes on the input tags to gather customer information before sending it to our servers.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"In order for recurly.js to inject the card payment hosted fields into your form, the target elements must be present in the document at the time you make the `recurly.configure` call.\"\n}\n[/block]\n**Note** that card data is not present in the form, but merely given a placeholder element. This is because Recurly.js must inject those fields onto the page within iframes to ensure strict security of customer card data. To further customize your checkout experience, you will be able to pick and use any color for the placeholder text.\n\nThis particular form contains the minimum required input fields, and **the table below demonstrates all possible input fields.**\n\n### Card data\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field Name\",\n    \"h-1\": \"Example\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"number\",\n    \"1-0\": \"month\",\n    \"2-0\": \"year\",\n    \"3-0\": \"first_name\",\n    \"4-0\": \"last_name\",\n    \"5-0\": \"cvv\",\n    \"0-1\": \"`4111-1111-1111-1111`\",\n    \"1-1\": \"`8` or `02`\",\n    \"2-1\": \"`18` or `2018`\",\n    \"3-1\": \"`Pat`\",\n    \"4-1\": \"`Smith`\",\n    \"5-1\": \"`123`\",\n    \"0-2\": \"Credit card number. **Required**\",\n    \"1-2\": \"Card expiration month as a number. **Required**\",\n    \"2-2\": \"Card expiration year as a number. **Required**\",\n    \"3-2\": \"Cardholder first name. **Required**\",\n    \"4-2\": \"Cardholder last name. **Required**\",\n    \"5-2\": \"Card security code.\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\nDepending on how you've configured your [billing address requirements](http://docs.recurly.com/site-settings#address_requirements), some of the following fields may be required.\n\n### Billing address\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field Name\",\n    \"h-1\": \"Example\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"address1\",\n    \"0-1\": \"`1313 Main St.`\",\n    \"0-2\": \"First line of a street address.\",\n    \"1-0\": \"address2\",\n    \"1-1\": \"`Unit 1`\",\n    \"1-2\": \"Second line of a street address.\",\n    \"2-0\": \"city\",\n    \"2-1\": \"`Hope`\",\n    \"2-2\": \"Town or locality.\",\n    \"3-0\": \"state\",\n    \"3-1\": \"`WA`\",\n    \"3-2\": \"Province or region.\",\n    \"4-0\": \"postal_code\",\n    \"4-1\": \"`98552`\",\n    \"4-2\": \"Postal code.\",\n    \"5-0\": \"country\",\n    \"5-1\": \"`US`\",\n    \"5-2\": \"[ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code.\",\n    \"6-0\": \"phone\",\n    \"6-1\": \"`555-867-5309`\",\n    \"6-2\": \"Phone number.\",\n    \"7-0\": \"vat_number\",\n    \"7-1\": \"`SE0000`\",\n    \"7-2\": \"Customer VAT number. Used for VAT exclusion.\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]\n## Styling card fields\n\nSince card fields must be injected within iframes, any font style information must be passed to recurly.configure\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"recurly.configure({\\n  // ...\\n  fields: {\\n    number: '#recurly-number',\\n    month: '#recurly-month',\\n    year: '#recurly-year',\\n    cvv: '#recurly-cvv'\\n  },\\n  style: {\\n    all: {\\n      fontFamily: 'Droid Sans',\\n      fontSize: '14px',\\n      fontColor: 'green',\\n      fontWeight: 'bold',\\n      fontVariant: 'small-caps',\\n      fontStyle: 'italic',\\n      lineHeight: '1em',\\n      placeholder: {\\n        color: 'gray !important'\\n      }\\n    },\\n    number: {\\n      fontColor: '#000000',\\n      placeholder: {\\n        content: 'Credit Card Number'\\n      }\\n    },\\n    month: {\\n      fontColor: 'rgba(20, 200, 10, 0.5)',\\n      placeholder: {\\n        content: 'Month (mm)'\\n      }\\n    },\\n    year: {\\n      placeholder: {\\n        content: 'Year (yy)'\\n      }\\n    },\\n    cvv: {\\n      fontSize: '12px',\\n      placeholder: {\\n        content: 'Security Code',\\n        color: 'red !important'\\n      }\\n    }\\n  }\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nSince Recurly.js must inject card data fields into iframes, the default browser appearance for those fields will likely not match the appearance of the other fields in your payment form. We provide the following CSS classes to achieve a look and feel similar to your form. Using these classes, you may specify field size, colors, and a full range of appearance customization to make the injected card fields blend into your payment form.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Class Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"recurly-hosted-field\",\n    \"1-0\": \"recurly-hosted-field-focus\",\n    \"2-0\": \"recurly-hosted-field-number\",\n    \"3-0\": \"recurly-hosted-field-month\",\n    \"4-0\": \"recurly-hosted-field-year\",\n    \"5-0\": \"recurly-hosted-field-cvv | Default styles for the div surrounding the cvv field iframe\",\n    \"3-1\": \"Default styles for the div surrounding the month field iframe.\",\n    \"4-1\": \"Default styles for the div surrounding the year field iframe.\",\n    \"2-1\": \"Default styles for the div surrounding the month field iframe.\",\n    \"1-1\": \"Applied when the user focuses on a field.\",\n    \"0-1\": \"Default styles for the div surrounding each field iframe.\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n### Fonts\n\nYou may specify font and placeholder text for card fields through `recurly.configure`. The example call to the right demonstrates all available style attributes you may send to `recurly.configure`.\n\nCustom fonts are sourced from [Google Web Fonts](https://www.google.com/fonts). Simply use the name of the font as it appears on the Google Web Fonts site.\n\n### Responsive styles\n\nAll of the built in field classes will support and respond to media queries. You may call `recurly.configure` again to change style properties -- thus you may change any property if the window size changes.\n\n## Working with bank accounts\n\nJust like a card form, use the data-recurly attribute to identify fields to Recurly.js. Since Recurly.js does not need to inject fields for bank accounts, all fields may be displayed as inputs on your payment form.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<form>\\n  <input type=\\\"text\\\" data-recurly=\\\"routing_number\\\">\\n  <input type=\\\"text\\\" data-recurly=\\\"account_number\\\">\\n  <input type=\\\"text\\\" data-recurly=\\\"account_number_confirmation\\\">\\n  <input type=\\\"text\\\" data-recurly=\\\"account_type\\\">\\n  <input type=\\\"text\\\" data-recurly=\\\"name_on_account\\\">\\n  <input type=\\\"hidden\\\" name=\\\"recurly-token\\\" data-recurly=\\\"token\\\">\\n  <button>submit</button>\\n</form>\",\n      \"language\": \"html\"\n    }\n  ]\n}\n[/block]\nAs you would a card form, you collect bank account payment information from your customers, identifying them with the `data-recurly` attributes on the input tags. This form demonstrates the minimum required input fields, and __the table below highlights all possible input fields.__\n\n### Bank Account data\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field Name\",\n    \"h-1\": \"Example\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"routing_number\",\n    \"0-1\": \"`123456789`\",\n    \"0-2\": \"Routing number. **Required**\",\n    \"1-0\": \"account_number\",\n    \"2-0\": \"account_number_confirmation\",\n    \"3-0\": \"account_type\",\n    \"4-0\": \"name_on_account\",\n    \"4-1\": \"`Pat Smith`\",\n    \"3-1\": \"`checking` or `savings`\",\n    \"2-1\": \"`987654321`\",\n    \"1-1\": \"`987654321`\",\n    \"1-2\": \"Account number. **Required**\",\n    \"2-2\": \"Account number confirmation. **Required**\",\n    \"3-2\": \"Account type. **Required**\",\n    \"4-2\": \"Full name on account. **Required**\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n### Billing address\n\n[See card billing address]","category":"578e7c59b434c30e0035bf29","createdAt":"2016-03-01T03:21:56.345Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"getting-started-1","sync_unique":"","title":"Getting Started","type":"basic","updates":["57180cd7602b9c0e000dab2c","57ab8820db6b2e0e003e7dc8","57ac7a1af1cdae0e0053ce8c","57bdcc85342bcf0e00d5afb8"],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

Getting Started


Include

<script src="https://js.recurly.com/v4/recurly.js"></script>

To begin, you'll include the Recurly.js script on your page.

This exposes a single global object, recurly.

Configure

recurly.configure('sc-ABCDEFGHI123456789');

Simply call recurly.configure anywhere on your page, passing your public key. This identifies your site to Recurly servers. You can find your public key in the API Access section of your admin app.

Be sure to replace sc-ABCDEFGHI123456789 with your own public key.

recurly.configure accepts other options not detailed here. You may refer to the source for more detail.

Build a Card form

Build a form however you like. Use the data-recurly attribute to identify input field targets to Recurly.js. To identify where Recurly.js will inject card data fields, we recommend using simple div elements.

<form>
  <input type="text" data-recurly="first_name">
  <input type="text" data-recurly="last_name">
  <div data-recurly="number"></div>
  <div data-recurly="month"></div>
  <div data-recurly="year"></div>
  <div data-recurly="cvv"></div>
  <input type="hidden" name="recurly-token" data-recurly="token">
  <button>submit</button>
</form>

To collect card payment information from your customers, you'll create a form similar to this one. Recurly.js uses the data-recurly attributes on the input tags to gather customer information before sending it to our servers.

In order for recurly.js to inject the card payment hosted fields into your form, the target elements must be present in the document at the time you make the recurly.configure call.

Note that card data is not present in the form, but merely given a placeholder element. This is because Recurly.js must inject those fields onto the page within iframes to ensure strict security of customer card data. To further customize your checkout experience, you will be able to pick and use any color for the placeholder text.

This particular form contains the minimum required input fields, and the table below demonstrates all possible input fields.

Card data

Field Name
Example
Description

number

4111-1111-1111-1111

Credit card number. Required

month

8 or 02

Card expiration month as a number. Required

year

18 or 2018

Card expiration year as a number. Required

first_name

Pat

Cardholder first name. Required

last_name

Smith

Cardholder last name. Required

cvv

123

Card security code.

Depending on how you've configured your billing address requirements, some of the following fields may be required.

Billing address

Field Name
Example
Description

address1

1313 Main St.

First line of a street address.

address2

Unit 1

Second line of a street address.

city

Hope

Town or locality.

state

WA

Province or region.

postal_code

98552

Postal code.

country

US

ISO 3166-1 alpha-2 country code.

phone

555-867-5309

Phone number.

vat_number

SE0000

Customer VAT number. Used for VAT exclusion.

Styling card fields

Since card fields must be injected within iframes, any font style information must be passed to recurly.configure

recurly.configure({
  // ...
  fields: {
    number: '#recurly-number',
    month: '#recurly-month',
    year: '#recurly-year',
    cvv: '#recurly-cvv'
  },
  style: {
    all: {
      fontFamily: 'Droid Sans',
      fontSize: '14px',
      fontColor: 'green',
      fontWeight: 'bold',
      fontVariant: 'small-caps',
      fontStyle: 'italic',
      lineHeight: '1em',
      placeholder: {
        color: 'gray !important'
      }
    },
    number: {
      fontColor: '#000000',
      placeholder: {
        content: 'Credit Card Number'
      }
    },
    month: {
      fontColor: 'rgba(20, 200, 10, 0.5)',
      placeholder: {
        content: 'Month (mm)'
      }
    },
    year: {
      placeholder: {
        content: 'Year (yy)'
      }
    },
    cvv: {
      fontSize: '12px',
      placeholder: {
        content: 'Security Code',
        color: 'red !important'
      }
    }
  }
});

Since Recurly.js must inject card data fields into iframes, the default browser appearance for those fields will likely not match the appearance of the other fields in your payment form. We provide the following CSS classes to achieve a look and feel similar to your form. Using these classes, you may specify field size, colors, and a full range of appearance customization to make the injected card fields blend into your payment form.

Class Name
Description

recurly-hosted-field

Default styles for the div surrounding each field iframe.

recurly-hosted-field-focus

Applied when the user focuses on a field.

recurly-hosted-field-number

Default styles for the div surrounding the month field iframe.

recurly-hosted-field-month

Default styles for the div surrounding the month field iframe.

recurly-hosted-field-year

Default styles for the div surrounding the year field iframe.

Fonts

You may specify font and placeholder text for card fields through recurly.configure. The example call to the right demonstrates all available style attributes you may send to recurly.configure.

Custom fonts are sourced from Google Web Fonts. Simply use the name of the font as it appears on the Google Web Fonts site.

Responsive styles

All of the built in field classes will support and respond to media queries. You may call recurly.configure again to change style properties -- thus you may change any property if the window size changes.

Working with bank accounts

Just like a card form, use the data-recurly attribute to identify fields to Recurly.js. Since Recurly.js does not need to inject fields for bank accounts, all fields may be displayed as inputs on your payment form.

<form>
  <input type="text" data-recurly="routing_number">
  <input type="text" data-recurly="account_number">
  <input type="text" data-recurly="account_number_confirmation">
  <input type="text" data-recurly="account_type">
  <input type="text" data-recurly="name_on_account">
  <input type="hidden" name="recurly-token" data-recurly="token">
  <button>submit</button>
</form>

As you would a card form, you collect bank account payment information from your customers, identifying them with the data-recurly attributes on the input tags. This form demonstrates the minimum required input fields, and the table below highlights all possible input fields.

Bank Account data

Field Name
Example
Description

routing_number

123456789

Routing number. Required

account_number

987654321

Account number. Required

account_number_confirmation

987654321

Account number confirmation. Required

account_type

checking or savings

Account type. Required

name_on_account

Pat Smith

Full name on account. Required

Billing address

[See card billing address]

{"__v":1,"_id":"578e7c5ab434c30e0035bf87","api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"body":"Interrupt the form submit to send billing info to Recurly and get a secure token in exchange. Once you have the token, submit the form to your server.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$('form').on('submit', function (event) {\\n  var form = this;\\n  event.preventDefault();\\n  recurly.token(form, function (err, token) {\\n    if (err) {\\n      // handle error using err.code and err.fields\\n    } else {\\n      // recurly.js has filled in the 'token' field, so now we can submit the\\n      // form to your server; alternatively, you can access token.id and do\\n      // any processing you wish\\n      form.submit();\\n    }\\n  });\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nRecurly.js works with tokens, which represent secure and temporary storage for your customer's sensitive billing information. They are stored directly on Recurly servers to reduce your PCI exposure.\n\nWhen your customers submit your billing form, you'll need to interrupt the submit and ask Recurly.js to create a token from the form. You may have noticed an additional hidden field in the form above, `token`. When you ask Recurly.js for a token during submit, it will automatically populate this field for you. After you get the token, you will submit it to your servers and use it there to talk to any endpoint in our API that accepts a `billing_info`.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"This example demonstrates jQuery as an event-binding and DOM library; however, you may use any library you choose, or interact directly with the DOM (hard mode).\"\n}\n[/block]\n## recurly.token (API)\n\nYou must call recurly.token with your form element.\n\n`recurly.token(document.querySelector('form'), tokenHandler);`\n\nUsing a handler function like this one:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"function tokenHandler (err, token) {\\n  if (err) {\\n    // handle error using err.code and err.fields\\n  } else {\\n    // handle success using token.id\\n  }\\n}\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nSends billing information to Recurly to store as a token, sending that token id back to you. There are two ways to call `recurly.token`: with a form, and with an object.\n\nThe simplest is to pass it a form element containing form fields with their corresponding `data-recurly` attributes.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Param\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"form\",\n    \"0-1\": \"`HTMLFormElement`\",\n    \"0-2\": \"Parent form containing `data-recurly` fields.\",\n    \"1-0\": \"callback\",\n    \"1-1\": \"`Function`\",\n    \"1-2\": \"Callback function to accept the returned token.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\nA callback is always required\n\n### Callback Arguments\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Param\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"err\",\n    \"1-0\": \"token\",\n    \"2-0\": \"id\",\n    \"0-1\": \"`RecurlyError` or `null`\",\n    \"0-2\": \"A [`RecurlyError`](#errors) if an error occurred; otherwise `null`.\",\n    \"1-1\": \"`Object`\",\n    \"1-2\": \"An object containing a token id.\",\n    \"2-1\": \"`String`\",\n    \"2-2\": \"A token id.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n### Returns\n\nNothing.\n\n## recurly.bankAccount.token(API)\n\nYou may call recurly.bankAccount.token with a form element\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"recurly.bankAccount.token(document.querySelector('form'), tokenHandler);\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nOr with an Object\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"// alternatively..\\nvar billingInfo = {\\n  // required attributes\\n  routing_number: '123456780',\\n  account_number: '111111111',\\n  account_number_confirmation: '111111111',\\n  account_type: 'checking',\\n  name_on_account: 'Pat Smith',\\n\\n  // optional attributes\\n  address1: '123 Main St.',\\n  address2: 'Unit 1',\\n  city: 'Hope',\\n  state: 'WA',\\n  postal_code: '98552',\\n  country: 'US',\\n  vat_number: 'SE0000'\\n};\\n\\nrecurly.bankAccount.token(billingInfo, tokenHandler);\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nBoth methods require using a handler function like this one\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"function tokenHandler (err, token) {\\n  if (err) {\\n    // handle error using err.code and err.fields\\n  } else {\\n    // handle success using token.id\\n  }\\n}\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nSends bank account billing information to Recurly to store as a token, sending that token id back to you. Just as with card tokenization, there are two ways to call `recurly.bankAccount.token`: with a form, and with an object.\n\nThe simplest is to pass it a form element containing form fields with their corresponding `data-recurly` attributes.\n\n### Arguments (form)\n[block:parameters]\n{\n  \"data\": {\n    \"1-0\": \"callback\",\n    \"0-0\": \"form\",\n    \"h-0\": \"Param\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-1\": \"`HTMLFormElement`\",\n    \"0-2\": \"Parent form containing `data-recurly` fields.\",\n    \"1-1\": \"`Function`\",\n    \"1-2\": \"Callback function to accept the returned token.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\nAlternatively, you can call `recurly.bankAccount.token` with a plain JavaScript object. This allows a more direct interface to the payment flow, eliminating any need to use the DOM.\n\n### Arguments (object)\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"options\",\n    \"1-0\": \"callback\",\n    \"0-1\": \"`Object`\",\n    \"0-2\": \"An object with billing information properties matching those [outlined above].\",\n    \"1-1\": \"`Function`\",\n    \"1-2\": \"Callback function to accept the returned token.\",\n    \"h-0\": \"Param\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\nA callback is always required\n\n### Callback Arguments\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Param\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"err\",\n    \"1-0\": \"token\",\n    \"2-0\": \"id\",\n    \"2-1\": \"`String`\",\n    \"2-2\": \"A token id.\",\n    \"0-1\": \"`RecurlyError` or `null`\",\n    \"0-2\": \"A [`RecurlyError`](#errors) if an error occurred; otherwise `null`.\",\n    \"1-1\": \"`Object`\",\n    \"1-2\": \"An object containing a token id.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n### Returns\n\nNothing.","category":"578e7c59b434c30e0035bf29","createdAt":"2016-03-01T04:39:30.344Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"getting-a-token","sync_unique":"","title":"Getting a Token","type":"basic","updates":["57add44f5aa73d0e005fc68f"],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

Getting a Token


Interrupt the form submit to send billing info to Recurly and get a secure token in exchange. Once you have the token, submit the form to your server.

$('form').on('submit', function (event) {
  var form = this;
  event.preventDefault();
  recurly.token(form, function (err, token) {
    if (err) {
      // handle error using err.code and err.fields
    } else {
      // recurly.js has filled in the 'token' field, so now we can submit the
      // form to your server; alternatively, you can access token.id and do
      // any processing you wish
      form.submit();
    }
  });
});

Recurly.js works with tokens, which represent secure and temporary storage for your customer's sensitive billing information. They are stored directly on Recurly servers to reduce your PCI exposure.

When your customers submit your billing form, you'll need to interrupt the submit and ask Recurly.js to create a token from the form. You may have noticed an additional hidden field in the form above, token. When you ask Recurly.js for a token during submit, it will automatically populate this field for you. After you get the token, you will submit it to your servers and use it there to talk to any endpoint in our API that accepts a billing_info.

This example demonstrates jQuery as an event-binding and DOM library; however, you may use any library you choose, or interact directly with the DOM (hard mode).

recurly.token (API)

You must call recurly.token with your form element.

recurly.token(document.querySelector('form'), tokenHandler);

Using a handler function like this one:

function tokenHandler (err, token) {
  if (err) {
    // handle error using err.code and err.fields
  } else {
    // handle success using token.id
  }
}

Sends billing information to Recurly to store as a token, sending that token id back to you. There are two ways to call recurly.token: with a form, and with an object.

The simplest is to pass it a form element containing form fields with their corresponding data-recurly attributes.

Param
Type
Description

form

HTMLFormElement

Parent form containing data-recurly fields.

callback

Function

Callback function to accept the returned token.

A callback is always required

Callback Arguments

Param
Type
Description

err

RecurlyError or null

A RecurlyError if an error occurred; otherwise null.

token

Object

An object containing a token id.

id

String

A token id.

Returns

Nothing.

recurly.bankAccount.token(API)

You may call recurly.bankAccount.token with a form element

recurly.bankAccount.token(document.querySelector('form'), tokenHandler);

Or with an Object

// alternatively..
var billingInfo = {
  // required attributes
  routing_number: '123456780',
  account_number: '111111111',
  account_number_confirmation: '111111111',
  account_type: 'checking',
  name_on_account: 'Pat Smith',

  // optional attributes
  address1: '123 Main St.',
  address2: 'Unit 1',
  city: 'Hope',
  state: 'WA',
  postal_code: '98552',
  country: 'US',
  vat_number: 'SE0000'
};

recurly.bankAccount.token(billingInfo, tokenHandler);

Both methods require using a handler function like this one

function tokenHandler (err, token) {
  if (err) {
    // handle error using err.code and err.fields
  } else {
    // handle success using token.id
  }
}

Sends bank account billing information to Recurly to store as a token, sending that token id back to you. Just as with card tokenization, there are two ways to call recurly.bankAccount.token: with a form, and with an object.

The simplest is to pass it a form element containing form fields with their corresponding data-recurly attributes.

Arguments (form)

Param
Type
Description

form

HTMLFormElement

Parent form containing data-recurly fields.

callback

Function

Callback function to accept the returned token.

Alternatively, you can call recurly.bankAccount.token with a plain JavaScript object. This allows a more direct interface to the payment flow, eliminating any need to use the DOM.

Arguments (object)

Param
Type
Description

options

Object

An object with billing information properties matching those [outlined above].

callback

Function

Callback function to accept the returned token.

A callback is always required

Callback Arguments

Param
Type
Description

err

RecurlyError or null

A RecurlyError if an error occurred; otherwise null.

token

Object

An object containing a token id.

id

String

A token id.

Returns

Nothing.

{"__v":0,"_id":"578e7c5ab434c30e0035bf88","api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"body":"Create a new subscription with a token using one of our [client libraries](http://dev.recurly.com/client-libraries) or [API v2](https://dev.recurly.com).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$subscription = new Recurly_Subscription();\\n$subscription->plan_code = 'monthly_subscription';\\n\\n$subscription->account = new Recurly_Account();\\n$subscription->account->account_code = 'pat_smith';\\n$subscription->account->first_name = 'Pat';\\n$subscription->account->last_name = 'Smith';\\n$subscription->account->email = 'pat@enterpriseexecutive.com';\\n\\n$subscription->account->billing_info = new Recurly_BillingInfo();\\n$subscription->account->billing_info->token_id = 'TOKEN_ID';\\n\\n$subscription->create();\",\n      \"language\": \"php\"\n    },\n    {\n      \"code\": \"Recurly::Subscription.create! plan_code: :monthly_subscription,\\n  account: {\\n    account_code: 'pat_smith',\\n    billing_info: { token_id: 'TOKEN_ID' }\\n  }\",\n      \"language\": \"ruby\"\n    },\n    {\n      \"code\": \"subscription = recurly.Subscription(\\n  plan_code = 'monthly_subscription',\\n  account = recurly.Account(\\n    account_code = 'pat_smith',\\n    billing_info = recurly.BillingInfo(token_id = 'TOKEN_ID')\\n  )\\n)\\nsubscription.save()\",\n      \"language\": \"python\"\n    },\n    {\n      \"code\": \"var plan = Plans.Get(\\\"monthly_subscription\\\");\\nvar account = new Account(\\\"pat_smith\\\");\\nvar billingInfo = new BillingInfo(account) { TokenId = \\\"TOKEN_ID\\\" };\\nvar subscription = new Subscription(account, plan, \\\"USD\\\");\\n\\nsubscription.Create();\",\n      \"language\": \"csharp\"\n    },\n    {\n      \"code\": \"$ curl https://:subdomain.recurly.com/v2/subscriptions \\\\\\n    -u API_KEY \\\\\\n    -X POST \\\\\\n    -d '<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?> \\\\\\n<subscription> \\\\\\n  <plan_code>monthly_subscription</plan_code> \\\\\\n  <currency>USD</currency> \\\\\\n  <account> \\\\\\n    <account_code>pat_smith</account_code> \\\\\\n    <email>pat@enterpriseexecutive.com</email> \\\\\\n    <first_name>Pat</first_name> \\\\\\n    <last_name>Smith</last_name> \\\\\\n    <billing_info> \\\\\\n      <token_id>TOKEN_ID</token_id> \\\\\\n    </billing_info> \\\\\\n  </account> \\\\\\n</subscription>'\\n\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nOnce Recurly.js has stored your customer's sensitive data and given you a token reference, you will have 20 minutes to use it in our [API](https://dev.recurly.com). Expired tokens are permanently removed from the Recurly servers.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Tokens expire after 20 minutes.\"\n}\n[/block]\nTokens can be used to populate any account Billing Info data through our API. Simply assign it to the Billing Info's `token_id` property and we'll do the rest.\n\n### These endpoints accept tokens within Billing Info.\n\n- Subscription [`create`](https://dev.recurly.com/docs/create-subscription)\n- Account [`create`](https://dev.recurly.com/docs/create-an-account), [`update`](https://dev.recurly.com/docs/update-account)\n- Billing Info [`update`](https://dev.recurly.com/docs/update-an-accounts-billing-info-token)\n- Transaction [`create`](https://dev.recurly.com/docs/create-transaction)\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"If you use a token, no other attributes will be allowed on that Billing Info\\n  for that request.\"\n}\n[/block]","category":"578e7c59b434c30e0035bf29","createdAt":"2016-03-01T04:28:39.561Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"using-a-token","sync_unique":"","title":"Using a Token","type":"basic","updates":["5718f243459f6f0e0075070c"],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

Using a Token


Create a new subscription with a token using one of our client libraries or API v2.

$subscription = new Recurly_Subscription();
$subscription->plan_code = 'monthly_subscription';

$subscription->account = new Recurly_Account();
$subscription->account->account_code = 'pat_smith';
$subscription->account->first_name = 'Pat';
$subscription->account->last_name = 'Smith';
$subscription->account->email = 'pat@enterpriseexecutive.com';

$subscription->account->billing_info = new Recurly_BillingInfo();
$subscription->account->billing_info->token_id = 'TOKEN_ID';

$subscription->create();
Recurly::Subscription.create! plan_code: :monthly_subscription,
  account: {
    account_code: 'pat_smith',
    billing_info: { token_id: 'TOKEN_ID' }
  }
subscription = recurly.Subscription(
  plan_code = 'monthly_subscription',
  account = recurly.Account(
    account_code = 'pat_smith',
    billing_info = recurly.BillingInfo(token_id = 'TOKEN_ID')
  )
)
subscription.save()
var plan = Plans.Get("monthly_subscription");
var account = new Account("pat_smith");
var billingInfo = new BillingInfo(account) { TokenId = "TOKEN_ID" };
var subscription = new Subscription(account, plan, "USD");

subscription.Create();
$ curl https://:subdomain.recurly.com/v2/subscriptions \
    -u API_KEY \
    -X POST \
    -d '<?xml version="1.0" encoding="UTF-8"?> \
<subscription> \
  <plan_code>monthly_subscription</plan_code> \
  <currency>USD</currency> \
  <account> \
    <account_code>pat_smith</account_code> \
    <email>pat@enterpriseexecutive.com</email> \
    <first_name>Pat</first_name> \
    <last_name>Smith</last_name> \
    <billing_info> \
      <token_id>TOKEN_ID</token_id> \
    </billing_info> \
  </account> \
</subscription>'

Once Recurly.js has stored your customer's sensitive data and given you a token reference, you will have 20 minutes to use it in our API. Expired tokens are permanently removed from the Recurly servers.

Tokens expire after 20 minutes.

Tokens can be used to populate any account Billing Info data through our API. Simply assign it to the Billing Info's token_id property and we'll do the rest.

These endpoints accept tokens within Billing Info.

If you use a token, no other attributes will be allowed on that Billing Info
for that request.

{"__v":0,"_id":"578e7c5ab434c30e0035bf89","api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"body":"Listen to events using Emitter methods\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"// Listen to the 'change' event\\nrecurly.on('change', changeHandler);\\n\\n// But we're feeling indecisive today. Let's detach this event\\nrecurly.off('change', changeHandler);\\n\\n// .once will listen for one event then detach itself\\nrecurly.once('field:submit', function () {\\n  $('#my-payment-form').submit();\\n});\\n\\nfunction changeHandler (state) {\\n  // state.fields\\n}\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nExample RecurlyState object\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var recurlyState = {\\n  fields: {\\n    number: {\\n      valid: false,\\n      firstSix: '',\\n      lastFour: '',\\n      brand: 'unknown',\\n      empty: true,\\n      length: 0,\\n      focus: false\\n    },\\n    month: {\\n      valid: false,\\n      empty: true,\\n      length: 0,\\n      focus: false\\n    },\\n    year: {\\n      // same as month\\n    },\\n    cvv: {\\n      // same as month\\n    }\\n  }\\n}\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nA `Recurly` instance is an event emitter, and will emit events throughout the lifecycle of your customer's interaction with your payment form. Events can be attached using the `recurly.on` method and removed using `recurly.off`. The example to the right shows the various ways that you can attach and remove events.\n\n### Event: change\n\n`change` is emitted whenever a customer changes the state of hosted card fields, those that you may not otherwise observe directly with DOM events. For example, if your customer types '4' into the number field, then the state of the number field will change, and the `change` event will emit.\n\nThe `change` event emits a `RecurlyState` object, whose values are demonstrated to the right. This will give you useful insight into the entire state of the recurly-controlled components of your payment form.\n\n### Event: field:submit\n\n`field:submit` is emitted when a user presses the `enter` key while they are focused on a hosted field. Since this action typically submits a form, we recommend performing a payment form submission when this event is emitted.\n\nNote that you can detect the brand of the credit card entered using the \"brand\" field in the state object above.","category":"578e7c59b434c30e0035bf29","createdAt":"2016-03-01T18:53:08.841Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"events","sync_unique":"","title":"Events","type":"basic","updates":[],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

Events


Listen to events using Emitter methods

// Listen to the 'change' event
recurly.on('change', changeHandler);

// But we're feeling indecisive today. Let's detach this event
recurly.off('change', changeHandler);

// .once will listen for one event then detach itself
recurly.once('field:submit', function () {
  $('#my-payment-form').submit();
});

function changeHandler (state) {
  // state.fields
}

Example RecurlyState object

var recurlyState = {
  fields: {
    number: {
      valid: false,
      firstSix: '',
      lastFour: '',
      brand: 'unknown',
      empty: true,
      length: 0,
      focus: false
    },
    month: {
      valid: false,
      empty: true,
      length: 0,
      focus: false
    },
    year: {
      // same as month
    },
    cvv: {
      // same as month
    }
  }
}

A Recurly instance is an event emitter, and will emit events throughout the lifecycle of your customer's interaction with your payment form. Events can be attached using the recurly.on method and removed using recurly.off. The example to the right shows the various ways that you can attach and remove events.

Event: change

change is emitted whenever a customer changes the state of hosted card fields, those that you may not otherwise observe directly with DOM events. For example, if your customer types '4' into the number field, then the state of the number field will change, and the change event will emit.

The change event emits a RecurlyState object, whose values are demonstrated to the right. This will give you useful insight into the entire state of the recurly-controlled components of your payment form.

Event: field:submit

field:submit is emitted when a user presses the enter key while they are focused on a hosted field. Since this action typically submits a form, we recommend performing a payment form submission when this event is emitted.

Note that you can detect the brand of the credit card entered using the "brand" field in the state object above.

{"__v":0,"_id":"578e7c5ab434c30e0035bf8a","api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button>Subscribe with PayPal</button>\",\n      \"language\": \"html\"\n    }\n  ]\n}\n[/block]\nPlace a button on your page, then bind its click event to a recurly.paypal call.\n\nRecurly.js supports both traditional credit card and PayPal reference transactions.  A PayPal transaction is handled entirely within the PayPal checkout flow in a new window. Your customer will authorize a transaction within PayPal, then Recurly will record the authorization of the billing agreement and you'll receive a token  just as if your customer had used a credit card directly.  The same Recurly token rules apply when generated by `recurly.paypal`.\n\nYou will need to use the token within our API before it expires, and expired tokens cannot be retrieved.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"As with the rest of Recurly.js, there are no external dependencies. The example uses jQuery to demonstrate binding events, but this can be done any way you wish.\"\n}\n[/block]\n## recurly.paypal (API)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$('button').on('click', function () {\\n  var opts = { description: 'Monthly Subscription' };\\n  recurly.paypal(opts, function (err, token) {\\n    if (err) {\\n      // handle errors using err.code\\n    } else {\\n      // handle success using token.id;\\n    }\\n  });\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nLaunches a new window with a PayPal reference transaction flow, eventually tokenizing the PayPal billing agreement for use within the Recurly API.\n\n### Arguments\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Param\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-1\": \"`Object`\",\n    \"0-2\": \"Options to configure the PayPal agreement flow.\",\n    \"0-0\": \"options\",\n    \"1-0\": \"description\",\n    \"2-0\": \"callback\",\n    \"2-1\": \"`Function`\",\n    \"2-2\": \"A callback function to receive the token or any errors.\",\n    \"1-1\": \"`String`\",\n    \"1-2\": \"Agreement description. This may include any text you desire, including pricing information.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\nA callback is always required.\n\n### Callback Arguments\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Param\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"err\",\n    \"1-0\": \"token\",\n    \"2-0\": \"id\",\n    \"2-1\": \"`String`\",\n    \"2-2\": \"A token id\",\n    \"1-1\": \"`Object`\",\n    \"1-2\": \"An object containing a token id\",\n    \"0-1\": \"`RecurlyError` or `null`\",\n    \"0-2\": \"A [`RecurlyError`](https://dev.recurly.com/docs/errors-1) if an error occurred; otherwise `null`.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n### Returns\n\nNothing.","category":"578e7c59b434c30e0035bf29","createdAt":"2016-03-01T18:54:55.886Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":6,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"paypal","sync_unique":"","title":"Paypal","type":"basic","updates":[],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

Paypal


<button>Subscribe with PayPal</button>

Place a button on your page, then bind its click event to a recurly.paypal call.

Recurly.js supports both traditional credit card and PayPal reference transactions. A PayPal transaction is handled entirely within the PayPal checkout flow in a new window. Your customer will authorize a transaction within PayPal, then Recurly will record the authorization of the billing agreement and you'll receive a token just as if your customer had used a credit card directly. The same Recurly token rules apply when generated by recurly.paypal.

You will need to use the token within our API before it expires, and expired tokens cannot be retrieved.

As with the rest of Recurly.js, there are no external dependencies. The example uses jQuery to demonstrate binding events, but this can be done any way you wish.

recurly.paypal (API)

$('button').on('click', function () {
  var opts = { description: 'Monthly Subscription' };
  recurly.paypal(opts, function (err, token) {
    if (err) {
      // handle errors using err.code
    } else {
      // handle success using token.id;
    }
  });
});

Launches a new window with a PayPal reference transaction flow, eventually tokenizing the PayPal billing agreement for use within the Recurly API.

Arguments

Param
Type
Description

options

Object

Options to configure the PayPal agreement flow.

description

String

Agreement description. This may include any text you desire, including pricing information.

callback

Function

A callback function to receive the token or any errors.

A callback is always required.

Callback Arguments

Param
Type
Description

err

RecurlyError or null

A RecurlyError if an error occurred; otherwise null.

token

Object

An object containing a token id

id

String

A token id

Returns

Nothing.

{"__v":0,"_id":"578e7c5ab434c30e0035bf8b","api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"body":"Recurly automates complicated subscriptions, with many factors influencing total subscription price. With this in mind, Recurly.js provides a robust pricing module designed to make determining actual subscription costs as simple and flexible as possible.\n\nA Recurly.js pricing module can be attached to the form we created above, or to any other section of your page meant to display subscription pricing. Let's get to the specifics!\n\n## recurly.Pricing (API)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var pricing = recurly.Pricing();\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nCreates a `Pricing` instance.\n\n### No Arguments\n\n### Returns\n\n**recurly.Pricing** a new Pricing instance.\n\n## pricing.attach (API)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<section id=\\\"pricing\\\">\\n  <select data-recurly=\\\"plan\\\">\\n    <option value=\\\"basic\\\">Basic</option>\\n    <option value=\\\"notbasic\\\">Not Basic</option>\\n  </select>\\n  <input type=\\\"text\\\" data-recurly=\\\"coupon\\\">\\n</section>\",\n      \"language\": \"html\"\n    }\n  ]\n}\n[/block]\nUse pricing.attach to bind the <section> to the pricing calculator.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var pricing = recurly.Pricing();\\n\\npricing.attach(document.querySelector('#pricing'));\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nThis is the simplest way to use the pricing module. Simply pass a container element, and the pricing module with use all elements with a valid `data-recurly` attribute to determine price. When a value changes, the pricing module will automatically update its values. This allows your customers to manipulate a pricing form at will, and you will be able to react dynamically in any number of ways.\n\n### Arguments\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"container\",\n    \"0-1\": \"`HTMLElement`\",\n    \"0-2\": \"Parent element containing all `data-recurly` elements\",\n    \"h-0\": \"Param\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n### Returns\n\nNothing.\n\n### Elements\n\nElements bound to a pricing module may be for either input or output.\n\nInput elements should be user-manipulable elements like `input` or `select`. If you want to input a value but not let a customer manipulate it, use an `<input type=\"hidden\">`.\n\n### Input Elements\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field Name\",\n    \"h-1\": \"Example Value\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"plan\",\n    \"0-1\": \"`basic`\",\n    \"1-0\": \"plan_quantity\",\n    \"2-0\": \"coupon\",\n    \"3-0\": \"addon\",\n    \"4-0\": \"currency\",\n    \"5-0\": \"country\",\n    \"6-0\": \"postal_code\",\n    \"7-0\": \"tax_code\",\n    \"8-0\": \"vat_number\",\n    \"1-1\": \"`1`\",\n    \"2-1\": \"`15_off`\",\n    \"3-1\": \"`1`\",\n    \"4-1\": \"`USD`\",\n    \"5-1\": \"`US`\",\n    \"5-2\": \"[ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code.\",\n    \"4-2\": \"[ISO-4217 currency code](http://docs.recurly.com/currencies).\",\n    \"3-2\": \"Addon quantity. To identify the addon being modified, use the `data-recurly-addon` attribute to set the addon code.\",\n    \"2-2\": \"Coupon code.\",\n    \"1-2\": \"Play quantity. Defaults to 1 if not specified.\",\n    \"0-2\": \"Plan code.\",\n    \"6-2\": \"Customer postal code. Used primarily to compute taxes.\",\n    \"7-2\": \"Product tax code.\",\n    \"8-2\": \"Customer VAT number. Used for VAT exclusion.\",\n    \"6-1\": \"`90210`\",\n    \"7-1\": \"`digital`\",\n    \"8-1\": \"`SE0000`\"\n  },\n  \"cols\": 3,\n  \"rows\": 9\n}\n[/block]\nOutput elements should be plain text elements like `output`, `span`, or `div`.\n\n### Output Elements\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field Name\",\n    \"h-1\": \"Example Output\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"total_now\",\n    \"1-0\": \"subtotal_now\",\n    \"2-0\": \"addons_now\",\n    \"3-0\": \"discount_now\",\n    \"4-0\": \"setup_fee_now\",\n    \"5-0\": \"tax_now\",\n    \"6-0\": \"currency_code\",\n    \"7-0\": \"currency_symbol\",\n    \"7-1\": \"`$`, `€`\",\n    \"7-2\": \"Symbolic representation of `currency_code`.\",\n    \"6-1\": \"`USD`, `EUR`\",\n    \"6-2\": \"ISO-4217 currency code.\",\n    \"5-1\": \"`15.00`\",\n    \"5-2\": \"Total subscription taxation.\",\n    \"4-1\": \"`5.00`\",\n    \"4-2\": \"Subscription setup fee total.\",\n    \"3-1\": \"`5.00`\",\n    \"3-2\": \"Amount discounted with coupon use.\",\n    \"2-2\": \"Total addon cost.\",\n    \"2-1\": \"`10.00`\",\n    \"1-1\": \"`90.00`\",\n    \"1-2\": \"Subtotal of the following pricing components.\",\n    \"0-1\": \"`100.00`\",\n    \"0-2\": \"Total subscription cost due now.\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"`data-recurly` values ending in `_now` like `subtotal_now` have counterparts ending in `_next`. As you might expect, these correspond to the next billing cycle cost. These values are especially useful for plans with trial periods.\"\n}\n[/block]\n## Events\n\nExample price object emitted by the **change** event.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var pricingState = {\\n  now: {\\n    subtotal: '25.00',\\n    addons: '0.00',\\n    discount: '0.00',\\n    setup_fee: '25.00',\\n    tax: '0.00',\\n    total: '25.00'\\n  },\\n  next: {\\n    subtotal: '10.00',\\n    addons: '0.00',\\n    discount: '0.00',\\n    tax: '0.00',\\n    total: '10.00'\\n  },\\n  base: {\\n    plan: {\\n      setup_fee: '25.00',\\n      unit: '10.00'\\n    },\\n    addons: {\\n      thing1: '14.00', // cost of one 'thing1' addon\\n      thing2: '8.00'\\n    },\\n  },\\n  currency: {\\n    code: 'USD',\\n    symbol: '$'\\n  }\\n}\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nPricing instances emit events when various values are set or the price changes.\n\nA `Pricing` instance itself behaves as an event emitter, where events can be attached using the `pricing.on` method and removed using `pricing.off`, similarly to how events are managed on `recurly`.\n\n### Event: Change\n\n`change` is emitted whenever a pricing module has updated any of its pricing values. You can use this event to update your pricing display, compute total shopping costs, aggregate to analytics, etc.\n\nChange emits a price object, shown in detail to the right.\n\n### Event: set.*\n\n`set.*` events are emitted when specific pricing objects change on a pricing module. For example, when a customer changes their plan, the pricing module will send `set.plan`. This is especially useful for updating checkout previews based on what the customer has selected as one example.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`set.plan`\",\n    \"1-0\": \"`set.price`\",\n    \"2-0\": \"`set.addon`\",\n    \"5-0\": \"`set.currency`\",\n    \"4-0\": \"`set.address`\",\n    \"3-0\": \"`set.coupon`\",\n    \"0-1\": \"Plan object.\",\n    \"1-1\": \"Price object.\",\n    \"2-1\": \"Addon object.\",\n    \"3-1\": \"Coupon object.\",\n    \"4-1\": \"Address object.\",\n    \"5-1\": \"Currency code.\",\n    \"6-0\": \"`set.tax`\",\n    \"6-1\": \"Tax object.\"\n  },\n  \"cols\": 2,\n  \"rows\": 7\n}\n[/block]\n## Pricing API\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var pricing = recurly.Pricing();\\n\\npricing\\n  .plan('basic', { quantity: 1 })\\n  .currency('USD')\\n  .addon('addon1', { quantity: 2 })\\n  .coupon('coop')\\n  .address({\\n    country: 'US',\\n    postal_code: '90210'\\n  })\\n  .tax({\\n    tax_code: 'digital',\\n    vat_number: ''\\n  })\\n  .catch(function (err) {\\n    // err.code\\n  })\\n  .done(function (price) {\\n    // price object as emitted by 'change' event\\n  });\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nThe pricing module can be manipulated with a set of direct method calls. This is useful if you would like to set up a complex pricing schema for your customers, or would just like to use a more programmatic method of determining subscription price. Events fire just as they normally would when using `pricing.attach`.\n\nNote that Recurly.js's DOM binding is one-way. Thus if you use the Pricing API on a pricing instance already attached to a container, the elements within _will not_ update with your Pricing API calls. If you would like two-way DOM binding, we suggest using a framework such as [AngularJS](https://angularjs.org/) and using the Pricing API without attaching it to a container.\n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"The example to the right demonstrates all the ways that a pricing module can be manipulated directly.\"\n}\n[/block]\n### PricingPromise\n\nEach Pricing API method will return a `PricingPromise`. This allows you to chain many asynchronous calls together without having to manage a complex chain of callbacks.\n\nYou don't need to worry much about the internals of a `PricingPromise`, as it is designed to stay out of your way and facilitate asynchronous calls for you.\n\nThe `catch` method, as shown in the example, is used to handle error scenarios, such as when an addon cannot be applied to the selected plan.\n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"At the end of a chain of pricing method calls, be sure to call `.done()` as this tells the pricing module to begin calculating, and gives you the subscription price.\"\n}\n[/block]","category":"578e7c59b434c30e0035bf29","createdAt":"2016-03-01T18:58:37.649Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":7,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"pricing","sync_unique":"","title":"Pricing","type":"basic","updates":[],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

Pricing


Recurly automates complicated subscriptions, with many factors influencing total subscription price. With this in mind, Recurly.js provides a robust pricing module designed to make determining actual subscription costs as simple and flexible as possible.

A Recurly.js pricing module can be attached to the form we created above, or to any other section of your page meant to display subscription pricing. Let's get to the specifics!

recurly.Pricing (API)

var pricing = recurly.Pricing();

Creates a Pricing instance.

No Arguments

Returns

recurly.Pricing a new Pricing instance.

pricing.attach (API)

<section id="pricing">
  <select data-recurly="plan">
    <option value="basic">Basic</option>
    <option value="notbasic">Not Basic</option>
  </select>
  <input type="text" data-recurly="coupon">
</section>

Use pricing.attach to bind the

to the pricing calculator.

var pricing = recurly.Pricing();

pricing.attach(document.querySelector('#pricing'));

This is the simplest way to use the pricing module. Simply pass a container element, and the pricing module with use all elements with a valid data-recurly attribute to determine price. When a value changes, the pricing module will automatically update its values. This allows your customers to manipulate a pricing form at will, and you will be able to react dynamically in any number of ways.

Arguments

Param
Type
Description

container

HTMLElement

Parent element containing all data-recurly elements

Returns

Nothing.

Elements

Elements bound to a pricing module may be for either input or output.

Input elements should be user-manipulable elements like input or select. If you want to input a value but not let a customer manipulate it, use an <input type="hidden">.

Input Elements

Field Name
Example Value
Description

plan

basic

Plan code.

plan_quantity

1

Play quantity. Defaults to 1 if not specified.

coupon

15_off

Coupon code.

addon

1

Addon quantity. To identify the addon being modified, use the data-recurly-addon attribute to set the addon code.

currency

USD

country

US

ISO 3166-1 alpha-2 country code.

postal_code

90210

Customer postal code. Used primarily to compute taxes.

tax_code

digital

Product tax code.

vat_number

SE0000

Customer VAT number. Used for VAT exclusion.

Output elements should be plain text elements like output, span, or div.

Output Elements

Field Name
Example Output
Description

total_now

100.00

Total subscription cost due now.

subtotal_now

90.00

Subtotal of the following pricing components.

addons_now

10.00

Total addon cost.

discount_now

5.00

Amount discounted with coupon use.

setup_fee_now

5.00

Subscription setup fee total.

tax_now

15.00

Total subscription taxation.

currency_code

USD, EUR

ISO-4217 currency code.

currency_symbol

$,

Symbolic representation of currency_code.

data-recurly values ending in _now like subtotal_now have counterparts ending in _next. As you might expect, these correspond to the next billing cycle cost. These values are especially useful for plans with trial periods.

Events

Example price object emitted by the change event.

var pricingState = {
  now: {
    subtotal: '25.00',
    addons: '0.00',
    discount: '0.00',
    setup_fee: '25.00',
    tax: '0.00',
    total: '25.00'
  },
  next: {
    subtotal: '10.00',
    addons: '0.00',
    discount: '0.00',
    tax: '0.00',
    total: '10.00'
  },
  base: {
    plan: {
      setup_fee: '25.00',
      unit: '10.00'
    },
    addons: {
      thing1: '14.00', // cost of one 'thing1' addon
      thing2: '8.00'
    },
  },
  currency: {
    code: 'USD',
    symbol: '$'
  }
}

Pricing instances emit events when various values are set or the price changes.

A Pricing instance itself behaves as an event emitter, where events can be attached using the pricing.on method and removed using pricing.off, similarly to how events are managed on recurly.

Event: Change

change is emitted whenever a pricing module has updated any of its pricing values. You can use this event to update your pricing display, compute total shopping costs, aggregate to analytics, etc.

Change emits a price object, shown in detail to the right.

Event: set.*

set.* events are emitted when specific pricing objects change on a pricing module. For example, when a customer changes their plan, the pricing module will send set.plan. This is especially useful for updating checkout previews based on what the customer has selected as one example.

set.plan

Plan object.

set.price

Price object.

set.addon

Addon object.

set.coupon

Coupon object.

set.address

Address object.

set.currency

Currency code.

set.tax

Tax object.

Pricing API

var pricing = recurly.Pricing();

pricing
  .plan('basic', { quantity: 1 })
  .currency('USD')
  .addon('addon1', { quantity: 2 })
  .coupon('coop')
  .address({
    country: 'US',
    postal_code: '90210'
  })
  .tax({
    tax_code: 'digital',
    vat_number: ''
  })
  .catch(function (err) {
    // err.code
  })
  .done(function (price) {
    // price object as emitted by 'change' event
  });

The pricing module can be manipulated with a set of direct method calls. This is useful if you would like to set up a complex pricing schema for your customers, or would just like to use a more programmatic method of determining subscription price. Events fire just as they normally would when using pricing.attach.

Note that Recurly.js's DOM binding is one-way. Thus if you use the Pricing API on a pricing instance already attached to a container, the elements within will not update with your Pricing API calls. If you would like two-way DOM binding, we suggest using a framework such as AngularJS and using the Pricing API without attaching it to a container.

The example to the right demonstrates all the ways that a pricing module can be manipulated directly.

PricingPromise

Each Pricing API method will return a PricingPromise. This allows you to chain many asynchronous calls together without having to manage a complex chain of callbacks.

You don't need to worry much about the internals of a PricingPromise, as it is designed to stay out of your way and facilitate asynchronous calls for you.

The catch method, as shown in the example, is used to handle error scenarios, such as when an addon cannot be applied to the selected plan.

At the end of a chain of pricing method calls, be sure to call .done() as this tells the pricing module to begin calculating, and gives you the subscription price.

{"__v":0,"_id":"578e7c5ab434c30e0035bf8c","api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"body":"Recurly.js bundles a few helpful methods for validating payment information prior to processing. These methods are used when generating tokens, but you can also use them to enhance your form validations and checkout flow.\n\n## recurly.bankAccount.bankInfo (API)\n\nGet additional bank account info\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var lookupData = {\\n  routingNumber: '123456780'\\n};\\nrecurly.bankAccount.bankInfo(lookupData, infoHandler);\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nThe bankInfo method requires a handler like this one\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"function infoHandler (err, bankInfo) {\\n  if (err) {\\n    // handle error\\n  } else {\\n    // handle success using bankInfo\\n  }\\n}\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nLooks up additional bank information based from a given routing number. If the routing number supplied is invalid, `invalid-routing-number` will be the error code returned.\n\n### Lookup data\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field Name\",\n    \"h-1\": \"Example\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"routingNumber\",\n    \"0-1\": \"`123456780`\",\n    \"0-2\": \"The routing number for a bank\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n### Bank info data\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field Name\",\n    \"h-1\": \"Example\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"bank_name\",\n    \"0-1\": \"`Bank of Recurly`\",\n    \"0-2\": \"The name for the found bank\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]","category":"578e7c59b434c30e0035bf29","createdAt":"2016-03-01T19:17:35.326Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":8,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"validation","sync_unique":"","title":"Validation","type":"basic","updates":[],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

Validation


Recurly.js bundles a few helpful methods for validating payment information prior to processing. These methods are used when generating tokens, but you can also use them to enhance your form validations and checkout flow.

recurly.bankAccount.bankInfo (API)

Get additional bank account info

var lookupData = {
  routingNumber: '123456780'
};
recurly.bankAccount.bankInfo(lookupData, infoHandler);

The bankInfo method requires a handler like this one

function infoHandler (err, bankInfo) {
  if (err) {
    // handle error
  } else {
    // handle success using bankInfo
  }
}

Looks up additional bank information based from a given routing number. If the routing number supplied is invalid, invalid-routing-number will be the error code returned.

Lookup data

Field Name
Example
Description

routingNumber

123456780

The routing number for a bank

Bank info data

Field Name
Example
Description

bank_name

Bank of Recurly

The name for the found bank

{"__v":0,"_id":"578e7c5ab434c30e0035bf8d","api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"body":"Example RecurlyError object.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  name: 'validation',\\n  code: 'validation',\\n  message: 'There was an error validating your request.',\\n  fields: [\\n    'number',\\n    'year'\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nErrors are encapsulated by a `RecurlyError`, which contains a few standard properties to help you diagnose error cases and inform your customers accordingly.\n\nErrors will be thrown if the exception will prevent proper execution. If an error can be recovered, it will be passed to the proper error handling event listener, callback, or `PricingPromise` handler for you to inspect.\n\n### Best Practices\n\nThe `message` property contains diagnostic information intended to help you diagnose problems with the form, and we do not recommend displaying its contents to your customers.\n\nTo provide the best customer experience, we recommend that you provide your own error text to be displayed, based on the error code you receive.\n\n### Error Codes\n\n## Configuration\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Code\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"not-configured\",\n    \"1-0\": \"missing-public-key\",\n    \"2-0\": \"invalid-public-key\",\n    \"3-0\": \"already-configured\",\n    \"4-0\": \"missing-hosted-field-target\",\n    \"5-0\": \"\",\n    \"0-1\": \"This error appears when you try to perform an operation without first calling [`recurly.configure`](#configure).\",\n    \"2-1\": \"Check the `publicKey` to ensure it matches that of your admin app's [API Access section](https://app.recurly.com/go/developer/api_access).\",\n    \"1-1\": \"When you call [`recurly.configure`](#configure), you must do so with a `publicKey` property.\",\n    \"3-1\": \"A recurly instance may only be configured once. Doing so more than once is excessive.\",\n    \"4-1\": \"This is thrown when the target element for a hosted payment field cannot be found on the page. Check the error message to check the selector being used, then check your page to ensure the element is present when `recurly.configure` is called.\",\n    \"5-1\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n## Tokenization\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Code\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"validation\",\n    \"1-0\": \"invalid-parameter\",\n    \"2-0\": \"api-error\",\n    \"3-0\": \"\",\n    \"1-1\": \"Occurs when a tokenization parameter does not pass our internal validations. Check the `fields` property to determine which fields caused the error.\",\n    \"2-1\": \"A request to the Recurly API has encountered an issue. This too can indicate many possible issues, and we recommend inspecting the `message` and `fields` properties for more information.\",\n    \"3-1\": \"\",\n    \"0-1\": \"A request validation error has occurred. This can indicate many possible issues, and you should check the `fields` property to determine which fields caused the error.\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n## Pricing\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Code\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"not-found\",\n    \"1-0\": \"missing-plan\",\n    \"2-0\": \"invalid-addon\",\n    \"3-0\": \"invalid-currency\",\n    \"4-0\": \"\",\n    \"4-1\": \"\",\n    \"3-1\": \"Similarly, if a currency is requested which is not valid for the selected plan.\",\n    \"2-1\": \"Occurs when an addon is added to a [`Pricing`](#pricing) instance but is not valid for the instance's selected plan.\",\n    \"1-1\": \"A [`Pricing`](#pricing) instance will emit this if a plan has not been specified before trying to set a proeprty that depends on a plan, such as a coupon or addon.\",\n    \"0-1\": \"This happens when a nonexistent plan is requested.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n## PayPal\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"paypal-not-configured\",\n    \"0-1\": \"In order to perform a PayPal transaction, your site must be configured to accept PayPal reference\",\n    \"1-1\": \"The customer canceled the PayPal agreement flow.\",\n    \"2-1\": \"A generic PayPal error has occurred. Inspect `message` to learn more.\",\n    \"3-1\": \"The bank routing number is not valid\",\n    \"3-0\": \"invalid-routing-number\",\n    \"2-0\": \"paypal-error\",\n    \"1-0\": \"paypal-canceled\",\n    \"h-0\": \"Code\",\n    \"h-1\": \"Description\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","category":"578e7c59b434c30e0035bf29","createdAt":"2016-03-01T19:19:09.515Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":9,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"errors-1","sync_unique":"","title":"Errors","type":"basic","updates":[],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

Errors


Example RecurlyError object.

{
  name: 'validation',
  code: 'validation',
  message: 'There was an error validating your request.',
  fields: [
    'number',
    'year'
  ]
}

Errors are encapsulated by a RecurlyError, which contains a few standard properties to help you diagnose error cases and inform your customers accordingly.

Errors will be thrown if the exception will prevent proper execution. If an error can be recovered, it will be passed to the proper error handling event listener, callback, or PricingPromise handler for you to inspect.

Best Practices

The message property contains diagnostic information intended to help you diagnose problems with the form, and we do not recommend displaying its contents to your customers.

To provide the best customer experience, we recommend that you provide your own error text to be displayed, based on the error code you receive.

Error Codes

Configuration

Code
Description

not-configured

This error appears when you try to perform an operation without first calling recurly.configure.

missing-public-key

When you call recurly.configure, you must do so with a publicKey property.

invalid-public-key

Check the publicKey to ensure it matches that of your admin app's API Access section.

already-configured

A recurly instance may only be configured once. Doing so more than once is excessive.

missing-hosted-field-target

This is thrown when the target element for a hosted payment field cannot be found on the page. Check the error message to check the selector being used, then check your page to ensure the element is present when recurly.configure is called.

Tokenization

Code
Description

validation

A request validation error has occurred. This can indicate many possible issues, and you should check the fields property to determine which fields caused the error.

invalid-parameter

Occurs when a tokenization parameter does not pass our internal validations. Check the fields property to determine which fields caused the error.

api-error

A request to the Recurly API has encountered an issue. This too can indicate many possible issues, and we recommend inspecting the message and fields properties for more information.

Pricing

Code
Description

not-found

This happens when a nonexistent plan is requested.

missing-plan

A Pricing instance will emit this if a plan has not been specified before trying to set a proeprty that depends on a plan, such as a coupon or addon.

invalid-addon

Occurs when an addon is added to a Pricing instance but is not valid for the instance's selected plan.

invalid-currency

Similarly, if a currency is requested which is not valid for the selected plan.

PayPal

Code
Description

paypal-not-configured

In order to perform a PayPal transaction, your site must be configured to accept PayPal reference

paypal-canceled

The customer canceled the PayPal agreement flow.

paypal-error

A generic PayPal error has occurred. Inspect message to learn more.

invalid-routing-number

The bank routing number is not valid

{"__v":1,"_id":"578e7c5ab434c30e0035bf8e","api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"body":"### Integration examples\n\nWe've prepared a full suite of example integrations for *Ruby*, *Node.js*, *Python*, and *PHP* using popular web frameworks for each language. These examples demonstrate the simplest method of integration, with a no-frills UI.\n\n[Code on GitHub](https://github.com/recurly/recurly-js-examples)\n\n### Integration examples with UI\n\nTo demonstrate the bare minimum to more advanced features of Recurly.js, we've prepared example merchant integrations of varying complexity. These examples also include a fancy UI to get you going with something nice.\n\n[Subscribe with minimal billing Info](https://kale-krate.herokuapp.com/subscribe-minimal)\n\n[Subscribe with more billing Info](https://kale-krate.herokuapp.com/subscribe-more)\n\n[Subscribe with advanced pricing](https://kale-krate.herokuapp.com/subscribe-advanced)\n\n[One-time transactions](https://kale-krate.herokuapp.com/one-time-transaction)\n\n[Update billing info](https://kale-krate.herokuapp.com/update-billing)\n\nThe Kale Krate site is open source. Its backend is written in Ruby with [Sinatra](http://www.sinatrarb.com/) and the [Recurly gem](https://github.com/recurly/recurly-client-ruby). It is deployable out of the box to [Heroku](https://heroku.com).\n\n[Code on GitHub](https://github.com/recurly/kalekrate)","category":"578e7c59b434c30e0035bf29","createdAt":"2016-03-01T19:35:36.709Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":10,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"examples","sync_unique":"","title":"Examples","type":"basic","updates":["57bdd3037987bf170063f9b6"],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

Examples


Integration examples

We've prepared a full suite of example integrations for Ruby, Node.js, Python, and PHP using popular web frameworks for each language. These examples demonstrate the simplest method of integration, with a no-frills UI.

Code on GitHub

Integration examples with UI

To demonstrate the bare minimum to more advanced features of Recurly.js, we've prepared example merchant integrations of varying complexity. These examples also include a fancy UI to get you going with something nice.

Subscribe with minimal billing Info

Subscribe with more billing Info

Subscribe with advanced pricing

One-time transactions

Update billing info

The Kale Krate site is open source. Its backend is written in Ruby with Sinatra and the Recurly gem. It is deployable out of the box to Heroku.

Code on GitHub

{"__v":0,"_id":"578e7c5ab434c30e0035bf8f","api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"body":"Recurly.js supports Chrome, Firefox, Safari, iOS 6+, and IE 9+.\n\nWe're also here to lend a hand on any Recurly.js integration questions! You can get help from us in a handful of ways:\n\n* Find us and other fellow developers in [#recurly](irc://chat.freenode.net:+6697/recurly) on freenode to chat in real-time.\n* Browse and post questions on [Stackoverflow](http://stackoverflow.com/questions/tagged/recurly). We check these regularly.\n* Take a look at the code on [GitHub](https://github.com/recurly/recurly-js). We welcome bug reports through Issues and contributions through Pull Requests.\n\nFor other Recurly related questions, please contact [support@recurly.com](https://support.recurly.com) for help with your account or other general questions.\n\nFor copies of documentation for previous versions of Recurly.js, please contact support.","category":"578e7c59b434c30e0035bf29","createdAt":"2016-03-01T19:37:11.437Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":11,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"support","sync_unique":"","title":"Support","type":"basic","updates":[],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

Support


Recurly.js supports Chrome, Firefox, Safari, iOS 6+, and IE 9+.

We're also here to lend a hand on any Recurly.js integration questions! You can get help from us in a handful of ways:

  • Find us and other fellow developers in #recurly on freenode to chat in real-time.
  • Browse and post questions on Stackoverflow. We check these regularly.
  • Take a look at the code on GitHub. We welcome bug reports through Issues and contributions through Pull Requests.

For other Recurly related questions, please contact support@recurly.com for help with your account or other general questions.

For copies of documentation for previous versions of Recurly.js, please contact support.

{"__v":1,"_id":"578e7c5ab434c30e0035bf7c","api":{"auth":"required","examples":{"codes":[{"code":"","language":"text"}]},"params":[{"_id":"557f45d07eafa719001d1c2b","ref":"","in":"query","required":false,"desc":"The URL of adjustments for the specified account.","default":"","type":"string","name":"adjustments"},{"_id":"57a21cf65220910e002a1764","ref":"","in":"query","required":false,"desc":"The URL of the account balance for the specified account.","default":"","type":"string","name":"account_balance"},{"_id":"557f45d07eafa719001d1c2a","ref":"","in":"query","required":false,"desc":"The URL of billing info for the specified account.","default":"","type":"string","name":"billing_info"},{"_id":"557f45d07eafa719001d1c29","ref":"","in":"query","required":false,"desc":"The URL of invoices for the specified account.","default":"","type":"string","name":"invoices"},{"_id":"55e4aa556f190c1900a40881","ref":"","in":"query","required":false,"desc":"The URL of the coupon redemption for the specified account.","default":"","type":"string","name":"redemption"},{"_id":"55e4aa556f190c1900a40880","ref":"","in":"query","required":false,"desc":"The URL of subscriptions for the specified account.","default":"","type":"string","name":"subscriptions"},{"_id":"55e4aa556f190c1900a4087f","ref":"","in":"query","required":false,"desc":"The URL of transactions for the specified account.","default":"","type":"string","name":"transactions"},{"_id":"55e4aa556f190c1900a4087e","ref":"","in":"query","required":false,"desc":"The unique identifier of the account.","default":"","type":"string","name":"account_code"},{"_id":"55e4aa556f190c1900a4087d","ref":"","in":"query","required":false,"desc":"The state of accounts to return: `active` or `closed`.","default":"","type":"string","name":"state"},{"_id":"55e4aa556f190c1900a4087c","ref":"","in":"query","required":false,"desc":"The username of the account.","default":"","type":"string","name":"username"},{"_id":"55e4aa556f190c1900a4087b","ref":"","in":"query","required":false,"desc":"The email address of the account.","default":"","type":"string","name":"email"},{"_id":"560b18973bcbd80d0077d0c0","ref":"","in":"query","required":false,"desc":"Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.","default":"","type":"array_string","name":"cc_emails"},{"_id":"55e4aa556f190c1900a4087a","ref":"","in":"query","required":false,"desc":"The first name of the account.","default":"","type":"string","name":"first_name"},{"_id":"55e4aa556f190c1900a40879","ref":"","in":"query","required":false,"desc":"The last name of the account.","default":"","type":"string","name":"last_name"},{"_id":"55e4aa556f190c1900a40878","ref":"","in":"query","required":false,"desc":"The company name of the account.","default":"","type":"string","name":"company_name"},{"_id":"55e4aa556f190c1900a40877","ref":"","in":"query","required":false,"desc":"The VAT number of the account (to avoid having the VAT applied).","default":"","type":"string","name":"vat_number"},{"_id":"55e4aa556f190c1900a40876","ref":"","in":"query","required":false,"desc":"The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.","default":"","type":"boolean","name":"tax_exempt"},{"_id":"55e4aa556f190c1900a40875","ref":"","in":"query","required":false,"desc":"The nested address information of the account: `address1`, `address2`, `city`, `state`, `zip`, `country`, `phone`.","default":"","type":"object","name":"address"},{"_id":"55e4aa556f190c1900a40874","ref":"","in":"query","required":false,"desc":"The ISO 639-1 language code from the user's browser, indicating their preferred language and locale.","default":"","type":"string","name":"accept_language"},{"_id":"55e4aa556f190c1900a40873","ref":"","in":"query","required":false,"desc":"The unique token for automatically logging the account in to the hosted management pages. You may automatically log the user into their hosted management pages by directing the user to: `https://:subdomain.recurly.com/account/:hosted_login_token`.","default":"","type":"string","name":"hosted_login_token"},{"_id":"55e4aa556f190c1900a40872","ref":"","in":"query","required":false,"desc":"The date and time the account was created in Recurly.","default":"","type":"datetime","name":"created_at"},{"_id":"5783dc55359cd219005453ec","ref":"","in":"query","required":false,"desc":"The date and time the account or its billing info was last updated.","default":"","type":"datetime","name":"updated_at"},{"_id":"5783dcff359cd219005453ee","ref":"","in":"query","required":false,"desc":"For closed accounts, the date and time it was closed.","default":"","type":"datetime","name":"closed_at"}],"results":{"codes":[{"status":200,"language":"xml","code":"<account href=\"https://your-subdomain.recurly.com/v2/accounts/1\">\n  <adjustments href=\"https://your-subdomain.recurly.com/v2/accounts/1/adjustments\"/>\n  <billing_info href=\"https://your-subdomain.recurly.com/v2/accounts/1/billing_info\"/>\n  <invoices href=\"https://your-subdomain.recurly.com/v2/accounts/1/invoices\"/>\n  <redemptions href=\"https://your-subdomain.recurly.com/v2/accounts/1/redemptions\"/>\n  <subscriptions href=\"https://your-subdomain.recurly.com/v2/accounts/1/subscriptions\"/>\n  <transactions href=\"https://your-subdomain.recurly.com/v2/accounts/1/transactions\"/>\n  <account_code>1</account_code>\n  <state>active</state>\n  <username>verena1234</username>\n  <email>verena@example.com</email>\n  <cc_emails>bob@example.com,susan@example.com</cc_emails>\n  <first_name>Verena</first_name>\n  <last_name>Example</last_name>\n  <company_name>New Company Name</company_name>\n  <vat_number nil=\"nil\"/>\n  <tax_exempt type=\"boolean\">false</tax_exempt>\n  <address>\n    <address1>123 Main St.</address1>\n    <address2 nil=\"nil\"/>\n    <city>San Francisco</city>\n    <state>CA</state>\n    <zip>94105</zip>\n    <country>US</country>\n    <phone nil=\"nil\"/>\n  </address>\n  <accept_language nil=\"nil\"/>\n  <hosted_login_token>96e74bd5e14d18e6da463a0d638a2621</hosted_login_token>\n  <created_at type=\"datetime\">2016-07-08T20:59:43Z</created_at>\n  <updated_at type=\"datetime\">2016-07-11T17:56:24Z</updated_at>\n  <closed_at nil=\"nil\"/>\n</account>","name":""}]},"settings":"","url":"/accounts"},"body":"","category":"578e7c59b434c30e0035bf2a","createdAt":"2015-08-31T20:16:33.273Z","excerpt":"Accounts are core to managing your customers inside of Recurly. The account object stores the entire Recurly history of your customer and acts as the entry point for working with a customer's billing information, subscription data, transactions, invoices and more.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"account-object","sync_unique":"","title":"Account Object","type":"get","updates":["56cec52444c5700b0095c02b"],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

getAccount Object

Accounts are core to managing your customers inside of Recurly. The account object stores the entire Recurly history of your customer and acts as the entry point for working with a customer's billing information, subscription data, transactions, invoices and more.

adjustments:
string
The URL of adjustments for the specified account.
account_balance:
string
The URL of the account balance for the specified account.
billing_info:
string
The URL of billing info for the specified account.
invoices:
string
The URL of invoices for the specified account.
redemption:
string
The URL of the coupon redemption for the specified account.
subscriptions:
string
The URL of subscriptions for the specified account.
transactions:
string
The URL of transactions for the specified account.
account_code:
string
The unique identifier of the account.
state:
string
The state of accounts to return: `active` or `closed`.
username:
string
The username of the account.
email:
string
The email address of the account.
cc_emails:
array of strings
Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.
first_name:
string
The first name of the account.
last_name:
string
The last name of the account.
company_name:
string
The company name of the account.
vat_number:
string
The VAT number of the account (to avoid having the VAT applied).
tax_exempt:
boolean
The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.
address:
object
The nested address information of the account: `address1`, `address2`, `city`, `state`, `zip`, `country`, `phone`.
accept_language:
string
The ISO 639-1 language code from the user's browser, indicating their preferred language and locale.
hosted_login_token:
string
The unique token for automatically logging the account in to the hosted management pages. You may automatically log the user into their hosted management pages by directing the user to: `https://:subdomain.recurly.com/account/:hosted_login_token`.
created_at:
datetime
The date and time the account was created in Recurly.
updated_at:
datetime
The date and time the account or its billing info was last updated.
closed_at:
datetime
For closed accounts, the date and time it was closed.

Definition

{{ api_url }}{{ page_api_url }}

Result Format

<account href="https://your-subdomain.recurly.com/v2/accounts/1">
  <adjustments href="https://your-subdomain.recurly.com/v2/accounts/1/adjustments"/>
  <billing_info href="https://your-subdomain.recurly.com/v2/accounts/1/billing_info"/>
  <invoices href="https://your-subdomain.recurly.com/v2/accounts/1/invoices"/>
  <redemptions href="https://your-subdomain.recurly.com/v2/accounts/1/redemptions"/>
  <subscriptions href="https://your-subdomain.recurly.com/v2/accounts/1/subscriptions"/>
  <transactions href="https://your-subdomain.recurly.com/v2/accounts/1/transactions"/>
  <account_code>1</account_code>
  <state>active</state>
  <username>verena1234</username>
  <email>verena@example.com</email>
  <cc_emails>bob@example.com,susan@example.com</cc_emails>
  <first_name>Verena</first_name>
  <last_name>Example</last_name>
  <company_name>New Company Name</company_name>
  <vat_number nil="nil"/>
  <tax_exempt type="boolean">false</tax_exempt>
  <address>
    <address1>123 Main St.</address1>
    <address2 nil="nil"/>
    <city>San Francisco</city>
    <state>CA</state>
    <zip>94105</zip>
    <country>US</country>
    <phone nil="nil"/>
  </address>
  <accept_language nil="nil"/>
  <hosted_login_token>96e74bd5e14d18e6da463a0d638a2621</hosted_login_token>
  <created_at type="datetime">2016-07-08T20:59:43Z</created_at>
  <updated_at type="datetime">2016-07-11T17:56:24Z</updated_at>
  <closed_at nil="nil"/>
</account>


{"__v":2,"_id":"578e7c5ab434c30e0035bf7d","api":{"auth":"required","examples":{"codes":[{"language":"php","code":"<?php\n\n$accounts = Recurly_AccountList::getActive();\nforeach ($accounts as $account) {\n  print \"Account: $account\\n\";\n}\n","name":""},{"language":"ruby","code":"Recurly::Account.find_each do |account|\n  puts \"Account: #{account.inspect}\"\nend"},{"language":"python","code":"#client version 2.1.6+\nfor account in Account.all():\n    print 'Account: %s' % account\n\n#client version <= 2.1.5\naccounts = Account.all()\nwhile accounts:\n    for account in accounts:\n        print 'Account: %s' % account\n    try:\n        accounts = accounts.next_page()\n    except PageError:\n        accounts = ()"},{"name":null,"language":"csharp","code":"using System.Linq;\n\nvar accounts = Accounts.List();\nwhile (accounts.Any())\n{\n\tforeach (var account in accounts)\n\t\tConsole.WriteLine(account);\n\taccounts = accounts.Next;\n}"}]},"params":[{"_id":"56465088054d8f0d00bc76aa","ref":"","in":"query","required":false,"desc":"The state of accounts to return: `active`, `closed`, `subscriber`, `non_subscriber`, `past_due`.","default":"","type":"string","name":"state"},{"_id":"578ea5b0c93aac0e00ec8899","ref":"","in":"query","required":false,"desc":"The attribute that will be used to order records: `created_at`, `updated_at`.","default":"created_at","type":"string","name":"sort"},{"_id":"578ea5b0c93aac0e00ec8898","ref":"","in":"query","required":false,"desc":"The order in which products will be returned: `asc` for ascending order, `desc` for descending order.","default":"desc","type":"string","name":"order"},{"_id":"578ea5b0c93aac0e00ec8897","ref":"","in":"query","required":false,"desc":"Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes greater than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.","default":"","type":"datetime","name":"begin_time"},{"_id":"578ea5b0c93aac0e00ec8896","ref":"","in":"query","required":false,"desc":"Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes less than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.","default":"","type":"datetime","name":"end_time"},{"_id":"56d8bace7ce7550b00c81d77","ref":"","in":"query","required":false,"desc":"Number of records to return per page, up to a maximum of 200.","default":"50","type":"int","name":"per_page"},{"_id":"56d8bace7ce7550b00c81d78","ref":"","in":"query","required":false,"desc":"Splits records across pages. Leave blank to return the first page. Follow the URI in the first page's Link header to fetch the next page.","default":"","type":"int","name":"cursor"}],"results":{"codes":[{"status":200,"language":"xml","code":"<accounts type=\"array\">\n  <account href=\"https://your-subdomain.recurly.com/v2/accounts/1\">\n    <adjustments href=\"https://your-subdomain.recurly.com/v2/accounts/1/adjustments\"/>\n    <account_balance href=\"https://your-subdomain.recurly.com/v2/accounts/1/balance\"/>\n    <billing_info href=\"https://your-subdomain.recurly.com/v2/accounts/1/billing_info\"/>\n    <invoices href=\"https://your-subdomain.recurly.com/v2/accounts/1/invoices\"/>\n    <redemptions href=\"https://your-subdomain.recurly.com/v2/accounts/1/redemptions\"/>\n    <subscriptions href=\"https://your-subdomain.recurly.com/v2/accounts/1/subscriptions\"/>\n    <transactions href=\"https://your-subdomain.recurly.com/v2/accounts/1/transactions\"/>\n    <account_code>1</account_code>\n    <state>active</state>\n    <username>verena1234</username>\n    <email>verena@example.com</email>\n    <cc_emails>bob@example.com,susan@example.com</cc_emails>\n    <first_name>Verena</first_name>\n    <last_name>Example</last_name>\n    <company_name>Recurly Inc</company_name>\n    <vat_number nil=\"nil\"/>\n    <tax_exempt type=\"boolean\">false</tax_exempt>\n    <address>\n      <address1>123 Main St.</address1>\n      <address2 nil=\"nil\"/>\n      <city>San Francisco</city>\n      <state>CA</state>\n      <zip>94105</zip>\n      <country>US</country>\n      <phone nil=\"nil\"/>\n    </address>\n    <accept_language nil=\"nil\"/>\n    <hosted_login_token>71c122cb16fc90252ff845eacf5d7814</hosted_login_token>\n    <created_at type=\"datetime\">2016-08-03T15:44:05Z</created_at>\n    <updated_at type=\"datetime\">2016-08-03T16:26:26Z</updated_at>\n    <closed_at nil=\"nil\"/>\n  </account>\n</accounts>","name":""}]},"settings":"","url":"/accounts"},"body":"###Account Query States\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"state\",\n    \"h-1\": \"description\",\n    \"0-0\": \"`active`\",\n    \"1-0\": \"`closed`\",\n    \"0-1\": \"Open accounts.\",\n    \"1-1\": \"Accounts that are not open.\",\n    \"2-0\": \"`subscriber`\",\n    \"2-1\": \"Accounts with subscriptions that are valid for the current time. This includes subscriptions in a trial period.\",\n    \"3-0\": \"`non_subscriber`\",\n    \"3-1\": \"Accounts without subscriptions that are valid for the current time.\",\n    \"4-0\": \"`past_due`\",\n    \"4-1\": \"Accounts with invoices that have failed initial collection but still have collection attempts remaining.\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Please note: a queried state and the base state of a returned account may differ. For example, querying for `past_due` account will not result in a list of accounts with a `past_due` state (they will either be `active` or `closed`). Only base states (`active`, `closed`) will be present in the returned account records.\"\n}\n[/block]","category":"578e7c59b434c30e0035bf2a","createdAt":"2015-06-15T21:38:24.720Z","excerpt":"Returns a list of accounts on your site. Results are ordered by the time created, sorted by newest first.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"list-accounts","sync_unique":"","title":"List Accounts","type":"get","updates":["55f1f9abd4d3160d00439b6c"],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

getList Accounts

Returns a list of accounts on your site. Results are ordered by the time created, sorted by newest first.

state:
string
The state of accounts to return: `active`, `closed`, `subscriber`, `non_subscriber`, `past_due`.
sort:
stringcreated_at
The attribute that will be used to order records: `created_at`, `updated_at`.
order:
stringdesc
The order in which products will be returned: `asc` for ascending order, `desc` for descending order.
begin_time:
datetime
Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes greater than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.
end_time:
datetime
Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes less than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.
per_page:
integer50
Number of records to return per page, up to a maximum of 200.
cursor:
integer
Splits records across pages. Leave blank to return the first page. Follow the URI in the first page's Link header to fetch the next page.

Account Query States

state
description

active

Open accounts.

closed

Accounts that are not open.

subscriber

Accounts with subscriptions that are valid for the current time. This includes subscriptions in a trial period.

non_subscriber

Accounts without subscriptions that are valid for the current time.

past_due

Accounts with invoices that have failed initial collection but still have collection attempts remaining.

Please note: a queried state and the base state of a returned account may differ. For example, querying for past_due account will not result in a list of accounts with a past_due state (they will either be active or closed). Only base states (active, closed) will be present in the returned account records.

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php

$accounts = Recurly_AccountList::getActive();
foreach ($accounts as $account) {
  print "Account: $account\n";
}
Recurly::Account.find_each do |account|
  puts "Account: #{account.inspect}"
end
#client version 2.1.6+
for account in Account.all():
    print 'Account: %s' % account

#client version <= 2.1.5
accounts = Account.all()
while accounts:
    for account in accounts:
        print 'Account: %s' % account
    try:
        accounts = accounts.next_page()
    except PageError:
        accounts = ()
using System.Linq;

var accounts = Accounts.List();
while (accounts.Any())
{
	foreach (var account in accounts)
		Console.WriteLine(account);
	accounts = accounts.Next;
}

Result Format

<accounts type="array">
  <account href="https://your-subdomain.recurly.com/v2/accounts/1">
    <adjustments href="https://your-subdomain.recurly.com/v2/accounts/1/adjustments"/>
    <account_balance href="https://your-subdomain.recurly.com/v2/accounts/1/balance"/>
    <billing_info href="https://your-subdomain.recurly.com/v2/accounts/1/billing_info"/>
    <invoices href="https://your-subdomain.recurly.com/v2/accounts/1/invoices"/>
    <redemptions href="https://your-subdomain.recurly.com/v2/accounts/1/redemptions"/>
    <subscriptions href="https://your-subdomain.recurly.com/v2/accounts/1/subscriptions"/>
    <transactions href="https://your-subdomain.recurly.com/v2/accounts/1/transactions"/>
    <account_code>1</account_code>
    <state>active</state>
    <username>verena1234</username>
    <email>verena@example.com</email>
    <cc_emails>bob@example.com,susan@example.com</cc_emails>
    <first_name>Verena</first_name>
    <last_name>Example</last_name>
    <company_name>Recurly Inc</company_name>
    <vat_number nil="nil"/>
    <tax_exempt type="boolean">false</tax_exempt>
    <address>
      <address1>123 Main St.</address1>
      <address2 nil="nil"/>
      <city>San Francisco</city>
      <state>CA</state>
      <zip>94105</zip>
      <country>US</country>
      <phone nil="nil"/>
    </address>
    <accept_language nil="nil"/>
    <hosted_login_token>71c122cb16fc90252ff845eacf5d7814</hosted_login_token>
    <created_at type="datetime">2016-08-03T15:44:05Z</created_at>
    <updated_at type="datetime">2016-08-03T16:26:26Z</updated_at>
    <closed_at nil="nil"/>
  </account>
</accounts>


{"__v":0,"_id":"578e7c5ab434c30e0035bf7f","api":{"auth":"required","examples":{"codes":[{"language":"php","code":"<?php\n  \ntry {\n  $account = new Recurly_Account('b6f5783');\n  $account->email = 'verena@example.com';\n  $account->first_name = 'Verena';\n  $account->last_name = 'Example';\n  $account->create();\n\n  print \"Account: $account\\n\";\n\n} catch (Recurly_ValidationError $e) {\n  print \"Invalid Account: $e\";\n}","name":""},{"language":"ruby","code":"account = Recurly::Account.create(\n  :account_code => '1',\n  :email        => 'verena@example.com',\n  :first_name   => 'Verena',\n  :last_name    => 'Example'\n)"},{"language":"python","code":"account = Account(account_code='1')\naccount.email = 'verena@example.com'\naccount.first_name = 'Verena'\naccount.last_name = 'Example'\naccount.save()"},{"language":"csharp","code":"var account = new Account(\"1\")\n{\n  Email = \"verena@example.com\",\n  FirstName = \"Verena\",\n  LastName = \"Example\"\n};\naccount.Create();"},{"code":"<account>\n  <account_code>1</account_code>\n  <email>verena@example.com</email>\n  <first_name>Verena</first_name>\n  <last_name>Example</last_name>\n  <username>verena1234</username>\n  <cc_emails>bob@example.com,susan@example.com</cc_emails>\n  <company_name>Recurly Inc</company_name>\n  <address>\n    <address1>123 Main St.</address1>\n    <city>San Francisco</city>\n    <state>CA</state>\n    <zip>94105</zip>\n    <country>US</country>\n  </address>\n</account>","language":"xml"}]},"params":[{"_id":"557f3209e211d20d00601425","ref":"","in":"body","required":true,"desc":"A unique identifier used by your application to identify the account. This code may only contain the following characters: [a-z 0-9 @ - _ .] but it may not begin with a dot character. Max of 50 characters.","default":"","type":"string","name":"account_code"},{"_id":"557f3209e211d20d00601424","ref":"","in":"body","required":false,"desc":"The username for the account, ignore if you do not use usernames. Max of 255 characters.","default":"","type":"string","name":"username"},{"_id":"557f3209e211d20d00601423","ref":"","in":"body","required":false,"desc":"The email address for the account.","default":"","type":"string","name":"email"},{"_id":"557f32d1e211d20d00601430","ref":"","in":"body","required":false,"desc":"The first name for the account. Max of 255 characters.","default":"","type":"string","name":"first_name"},{"_id":"557f32d1e211d20d0060142f","ref":"","in":"body","required":false,"desc":"The last name for the account.  Max of 255 characters.","default":"","type":"string","name":"last_name"},{"_id":"557f32d1e211d20d0060142e","ref":"","in":"body","required":false,"desc":"The company name for the account. Max of 50 characters.","default":"","type":"string","name":"company_name"},{"_id":"557f32d1e211d20d0060142d","ref":"","in":"body","required":false,"desc":"The VAT number to avoid having the VAT applied (if applicable).","default":"","type":"string","name":"vat_number"},{"_id":"557f32d1e211d20d0060142c","ref":"","in":"body","required":false,"desc":"The tax status for the account.","default":"","type":"boolean","name":"tax_exempt"},{"_id":"557f32d1e211d20d0060142b","ref":"","in":"body","required":false,"desc":"The Avalara AvaTax value that can be passed to identify the customer type for tax purposes. The range of values can be A - R (more info at Avalara). Value is case-sensitive.","default":"","type":"string","name":"entity_use_code"},{"_id":"557f32d1e211d20d0060142a","ref":"","in":"body","required":false,"desc":"The nested billing information. If present, the account will only be created after the billing information is validated.","default":"","type":"object","name":"billing_info"},{"_id":"557f32d1e211d20d00601429","ref":"","in":"body","required":false,"desc":"The nested address information for the account: `address1`, `address2`, `city`, `state`, `zip`, `country`, `phone`.","default":"","type":"object","name":"address"},{"_id":"557f32d1e211d20d00601428","ref":"","in":"body","required":false,"desc":"The ISO 639-1 language code from the user's browser, indicating their preferred language and locale.","default":"","type":"string","name":"accept_language"},{"_id":"561c362cd308ee0d00749370","ref":"","in":"body","required":false,"desc":"Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.","default":"","type":"array_string","name":"cc_emails"}],"results":{"codes":[{"status":201,"language":"xml","code":"<account href=\"https://your-subdomain.recurly.com/v2/accounts/1\">\n  <adjustments href=\"https://your-subdomain.recurly.com/v2/accounts/1/adjustments\"/>\n  <account_balance href=\"https://your-subdomain.recurly.com/v2/accounts/1/balance\"/>\n  <invoices href=\"https://your-subdomain.recurly.com/v2/accounts/1/invoices\"/>\n  <subscriptions href=\"https://your-subdomain.recurly.com/v2/accounts/1/subscriptions\"/>\n  <transactions href=\"https://your-subdomain.recurly.com/v2/accounts/1/transactions\"/>\n  <account_code>1</account_code>\n  <state>active</state>\n  <username>verena1234</username>\n  <email>verena@example.com</email>\n  <cc_emails>bob@example.com,susan@example.com</cc_emails>\n  <first_name>Verena</first_name>\n  <last_name>Example</last_name>\n  <company_name>Recurly Inc</company_name>\n  <vat_number nil=\"nil\"/>\n  <tax_exempt type=\"boolean\">false</tax_exempt>\n  <address>\n    <address1>123 Main St.</address1>\n    <address2 nil=\"nil\"/>\n    <city>San Francisco</city>\n    <state>CA</state>\n    <zip>94105</zip>\n    <country>US</country>\n    <phone nil=\"nil\"/>\n  </address>\n  <accept_language nil=\"nil\"/>\n  <hosted_login_token>71c122cb16fc90252ff845eacf5d7814</hosted_login_token>\n  <created_at type=\"datetime\">2016-08-03T15:44:05Z</created_at>\n  <updated_at type=\"datetime\">2016-08-03T15:44:05Z</updated_at>\n  <closed_at nil=\"nil\"/>\n</account>","name":""}]},"settings":"","url":"/accounts"},"body":"","category":"578e7c59b434c30e0035bf2a","createdAt":"2015-06-15T20:12:03.880Z","excerpt":"Creates a new account. You may optionally include billing information.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"create-an-account","sync_unique":"","title":"Create Account","type":"post","updates":["562908002c0fd9190067da26"],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

postCreate Account

Creates a new account. You may optionally include billing information.

account_code:
required
string
A unique identifier used by your application to identify the account. This code may only contain the following characters: [a-z 0-9 @ - _ .] but it may not begin with a dot character. Max of 50 characters.
username:
string
The username for the account, ignore if you do not use usernames. Max of 255 characters.
email:
string
The email address for the account.
first_name:
string
The first name for the account. Max of 255 characters.
last_name:
string
The last name for the account. Max of 255 characters.
company_name:
string
The company name for the account. Max of 50 characters.
vat_number:
string
The VAT number to avoid having the VAT applied (if applicable).
tax_exempt:
boolean
The tax status for the account.
entity_use_code:
string
The Avalara AvaTax value that can be passed to identify the customer type for tax purposes. The range of values can be A - R (more info at Avalara). Value is case-sensitive.
billing_info:
object
The nested billing information. If present, the account will only be created after the billing information is validated.
address:
object
The nested address information for the account: `address1`, `address2`, `city`, `state`, `zip`, `country`, `phone`.
accept_language:
string
The ISO 639-1 language code from the user's browser, indicating their preferred language and locale.
cc_emails:
array of strings
Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php
  
try {
  $account = new Recurly_Account('b6f5783');
  $account->email = 'verena@example.com';
  $account->first_name = 'Verena';
  $account->last_name = 'Example';
  $account->create();

  print "Account: $account\n";

} catch (Recurly_ValidationError $e) {
  print "Invalid Account: $e";
}
account = Recurly::Account.create(
  :account_code => '1',
  :email        => 'verena@example.com',
  :first_name   => 'Verena',
  :last_name    => 'Example'
)
account = Account(account_code='1')
account.email = 'verena@example.com'
account.first_name = 'Verena'
account.last_name = 'Example'
account.save()
var account = new Account("1")
{
  Email = "verena@example.com",
  FirstName = "Verena",
  LastName = "Example"
};
account.Create();
<account>
  <account_code>1</account_code>
  <email>verena@example.com</email>
  <first_name>Verena</first_name>
  <last_name>Example</last_name>
  <username>verena1234</username>
  <cc_emails>bob@example.com,susan@example.com</cc_emails>
  <company_name>Recurly Inc</company_name>
  <address>
    <address1>123 Main St.</address1>
    <city>San Francisco</city>
    <state>CA</state>
    <zip>94105</zip>
    <country>US</country>
  </address>
</account>

Result Format

<account href="https://your-subdomain.recurly.com/v2/accounts/1">
  <adjustments href="https://your-subdomain.recurly.com/v2/accounts/1/adjustments"/>
  <account_balance href="https://your-subdomain.recurly.com/v2/accounts/1/balance"/>
  <invoices href="https://your-subdomain.recurly.com/v2/accounts/1/invoices"/>
  <subscriptions href="https://your-subdomain.recurly.com/v2/accounts/1/subscriptions"/>
  <transactions href="https://your-subdomain.recurly.com/v2/accounts/1/transactions"/>
  <account_code>1</account_code>
  <state>active</state>
  <username>verena1234</username>
  <email>verena@example.com</email>
  <cc_emails>bob@example.com,susan@example.com</cc_emails>
  <first_name>Verena</first_name>
  <last_name>Example</last_name>
  <company_name>Recurly Inc</company_name>
  <vat_number nil="nil"/>
  <tax_exempt type="boolean">false</tax_exempt>
  <address>
    <address1>123 Main St.</address1>
    <address2 nil="nil"/>
    <city>San Francisco</city>
    <state>CA</state>
    <zip>94105</zip>
    <country>US</country>
    <phone nil="nil"/>
  </address>
  <accept_language nil="nil"/>
  <hosted_login_token>71c122cb16fc90252ff845eacf5d7814</hosted_login_token>
  <created_at type="datetime">2016-08-03T15:44:05Z</created_at>
  <updated_at type="datetime">2016-08-03T15:44:05Z</updated_at>
  <closed_at nil="nil"/>
</account>


{"__v":0,"_id":"578e7c5ab434c30e0035bf7e","api":{"auth":"required","examples":{"codes":[{"name":"","code":"<?php\n\ntry {\n  $account = Recurly_Account::get('1');\n  print \"Account: $account\\n\";\n} catch (Recurly_NotFoundError $e) {\n  print \"Account not found.\\n\";\n}","language":"php"},{"code":"begin\n  account = Recurly::Account.find '1'\n  puts \"Account: #{account.inspect}\"\nrescue Recurly::Resource::NotFound => e\n  puts e.message\nend","language":"ruby"},{"code":"try:\n  account = Account.get('1')\n  print \"Account: %s\" % account\nexcept NotFoundError:\n  print \"Account not found.\\n\"","language":"python"},{"code":"try\n{\n\tvar account = Accounts.Get(\"1\");\n\tConsole.WriteLine(\"Account \" + account);\n}\ncatch (NotFoundException e)\n{\n\tConsole.WriteLine(\"Account not found.\");\n}","language":"csharp"}]},"params":[{"_id":"557f478deb75d80d00af4086","ref":"","in":"path","required":true,"desc":"Account's unique code.","default":"","type":"string","name":"account_code"}],"results":{"codes":[{"name":"","code":"<account href=\"https://your-subdomain.recurly.com/v2/accounts/1\">\n  <adjustments href=\"https://your-subdomain.recurly.com/v2/accounts/1/adjustments\"/>\n  <account_balance href=\"https://your-subdomain.recurly.com/v2/accounts/1/balance\"/>\n  <billing_info href=\"https://your-subdomain.recurly.com/v2/accounts/1/billing_info\"/>\n  <invoices href=\"https://your-subdomain.recurly.com/v2/accounts/1/invoices\"/>\n  <redemptions href=\"https://your-subdomain.recurly.com/v2/accounts/1/redemptions\"/>\n  <subscriptions href=\"https://your-subdomain.recurly.com/v2/accounts/1/subscriptions\"/>\n  <transactions href=\"https://your-subdomain.recurly.com/v2/accounts/1/transactions\"/>\n  <account_code>1</account_code>\n  <state>active</state>\n  <username>verena1234</username>\n  <email>verena@example.com</email>\n  <cc_emails>bob@example.com,susan@example.com</cc_emails>\n  <first_name>Verena</first_name>\n  <last_name>Example</last_name>\n  <company_name>Recurly Inc</company_name>\n  <vat_number nil=\"nil\"/>\n  <tax_exempt type=\"boolean\">false</tax_exempt>\n  <address>\n    <address1>123 Main St.</address1>\n    <address2 nil=\"nil\"/>\n    <city>San Francisco</city>\n    <state>CA</state>\n    <zip>94105</zip>\n    <country>US</country>\n    <phone nil=\"nil\"/>\n  </address>\n  <accept_language nil=\"nil\"/>\n  <hosted_login_token>71c122cb16fc90252ff845eacf5d7814</hosted_login_token>\n  <created_at type=\"datetime\">2016-08-03T15:44:05Z</created_at>\n  <updated_at type=\"datetime\">2016-08-03T16:26:26Z</updated_at>\n  <closed_at nil=\"nil\"/>\n</account>","language":"xml","status":200}]},"settings":"","url":"/accounts/:account_code"},"body":"","category":"578e7c59b434c30e0035bf2a","createdAt":"2015-06-15T21:45:49.420Z","excerpt":"Returns information about a single account.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"get-account","sync_unique":"","title":"Lookup Account","type":"get","updates":["55bbdd4e1067fc1700510eed"],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

getLookup Account

Returns information about a single account.

account_code:
required
string
Account's unique code.

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php

try {
  $account = Recurly_Account::get('1');
  print "Account: $account\n";
} catch (Recurly_NotFoundError $e) {
  print "Account not found.\n";
}
begin
  account = Recurly::Account.find '1'
  puts "Account: #{account.inspect}"
rescue Recurly::Resource::NotFound => e
  puts e.message
end
try:
  account = Account.get('1')
  print "Account: %s" % account
except NotFoundError:
  print "Account not found.\n"
try
{
	var account = Accounts.Get("1");
	Console.WriteLine("Account " + account);
}
catch (NotFoundException e)
{
	Console.WriteLine("Account not found.");
}

Result Format

<account href="https://your-subdomain.recurly.com/v2/accounts/1">
  <adjustments href="https://your-subdomain.recurly.com/v2/accounts/1/adjustments"/>
  <account_balance href="https://your-subdomain.recurly.com/v2/accounts/1/balance"/>
  <billing_info href="https://your-subdomain.recurly.com/v2/accounts/1/billing_info"/>
  <invoices href="https://your-subdomain.recurly.com/v2/accounts/1/invoices"/>
  <redemptions href="https://your-subdomain.recurly.com/v2/accounts/1/redemptions"/>
  <subscriptions href="https://your-subdomain.recurly.com/v2/accounts/1/subscriptions"/>
  <transactions href="https://your-subdomain.recurly.com/v2/accounts/1/transactions"/>
  <account_code>1</account_code>
  <state>active</state>
  <username>verena1234</username>
  <email>verena@example.com</email>
  <cc_emails>bob@example.com,susan@example.com</cc_emails>
  <first_name>Verena</first_name>
  <last_name>Example</last_name>
  <company_name>Recurly Inc</company_name>
  <vat_number nil="nil"/>
  <tax_exempt type="boolean">false</tax_exempt>
  <address>
    <address1>123 Main St.</address1>
    <address2 nil="nil"/>
    <city>San Francisco</city>
    <state>CA</state>
    <zip>94105</zip>
    <country>US</country>
    <phone nil="nil"/>
  </address>
  <accept_language nil="nil"/>
  <hosted_login_token>71c122cb16fc90252ff845eacf5d7814</hosted_login_token>
  <created_at type="datetime">2016-08-03T15:44:05Z</created_at>
  <updated_at type="datetime">2016-08-03T16:26:26Z</updated_at>
  <closed_at nil="nil"/>
</account>


{"__v":0,"_id":"578e7c5ab434c30e0035bf80","api":{"auth":"required","examples":{"codes":[{"language":"php","code":"<?php\n\ntry {\n  $account = Recurly_Account::get('b6f5783');\n  $account->company_name = 'New Company Name';\n  $account->update();\n\n  print \"Account: $account\\n\";\n} catch (Recurly_NotFoundError $e) {\n  print \"Invalid account code: $e\";\n}","name":""},{"language":"ruby","code":"account = Recurly::Account.find('account_1')\naccount.company_name = 'New Company Name'\naccount.save"},{"language":"python","code":"account = Account.get('account_1')\naccount.company_name = 'New Company Name'\naccount.save()"},{"language":"csharp","code":"var account = Account.Get(\"account_1\");\naccount.CompanyName = 'New Company Name'\naccount.Update();"},{"language":"xml","code":"<account>\n  <company_name>New Company Name</company_name>\n</account>"}]},"params":[{"_id":"557f4a527eafa719001d1c43","ref":"","in":"path","required":true,"desc":"Account's unique code.","default":"","type":"string","name":"account_code"},{"_id":"557f4a527eafa719001d1c42","ref":"","in":"body","required":false,"desc":"The username for the account, ignore if you do not use usernames. Max of 255 characters.","default":"","type":"string","name":"username"},{"_id":"557f4a527eafa719001d1c41","ref":"","in":"body","required":false,"desc":"The email address for the account.","default":"","type":"string","name":"email"},{"_id":"557f4a527eafa719001d1c40","ref":"","in":"body","required":false,"desc":"The first name for the account. Max of 255 characters.","default":"","type":"string","name":"first_name"},{"_id":"557f4a527eafa719001d1c3f","ref":"","in":"body","required":false,"desc":"The last name for the account. Max of 255 characters.","default":"","type":"string","name":"last_name"},{"_id":"557f4a527eafa719001d1c3e","ref":"","in":"body","required":false,"desc":"The company name for the account. Max of 255 characters.","default":"","type":"string","name":"company_name"},{"_id":"557f4a527eafa719001d1c3d","ref":"","in":"body","required":false,"desc":"The VAT number to avoid having the VAT applied (if applicable).","default":"","type":"string","name":"vat_number"},{"_id":"557f4a527eafa719001d1c3c","ref":"","in":"body","required":false,"desc":"The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.","default":"","type":"boolean","name":"tax_exempt"},{"_id":"557f4a527eafa719001d1c3b","ref":"","in":"body","required":false,"desc":"The Avalara AvaTax value that can be passed to identify the customer type for tax purposes. The range of values can be A - R (more info at Avalara). Value is case-sensitive.","default":"","type":"string","name":"entity_use_code"},{"_id":"557f4a527eafa719001d1c3a","ref":"","in":"body","required":false,"desc":"The nested billing information. If present, the account will only be created after the billing information is validated.","default":"","type":"object","name":"billing_info"},{"_id":"557f4a527eafa719001d1c39","ref":"","in":"body","required":false,"desc":"The nested address information for the account: `address1`, `address2`, `city`, `state`, `zip`, `country`, `phone`.","default":"","type":"object","name":"address"},{"_id":"557f4a527eafa719001d1c38","ref":"","in":"body","required":false,"desc":"The ISO 639-1 language code from the user's browser, indicating their preferred language and locale.","default":"","type":"string","name":"accept_language"},{"_id":"561c3606d468a60d00f51ebe","ref":"","in":"body","required":false,"desc":"Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.","default":"","type":"array_string","name":"cc_emails"}],"results":{"codes":[{"name":"","code":"<account href=\"https://your-subdomain.recurly.com/v2/accounts/1\">\n  <adjustments href=\"https://your-subdomain.recurly.com/v2/accounts/1/adjustments\"/>\n  <account_balance href=\"https://your-subdomain.recurly.com/v2/accounts/1/balance\"/>\n  <billing_info href=\"https://your-subdomain.recurly.com/v2/accounts/1/billing_info\"/>\n  <invoices href=\"https://your-subdomain.recurly.com/v2/accounts/1/invoices\"/>\n  <redemptions href=\"https://your-subdomain.recurly.com/v2/accounts/1/redemptions\"/>\n  <subscriptions href=\"https://your-subdomain.recurly.com/v2/accounts/1/subscriptions\"/>\n  <transactions href=\"https://your-subdomain.recurly.com/v2/accounts/1/transactions\"/>\n  <account_code>1</account_code>\n  <state>active</state>\n  <username>verena1234</username>\n  <email>verena@example.com</email>\n  <cc_emails>bob@example.com,susan@example.com</cc_emails>\n  <first_name>Verena</first_name>\n  <last_name>Example</last_name>\n  <company_name>New Company Name</company_name>\n  <vat_number nil=\"nil\"/>\n  <tax_exempt type=\"boolean\">false</tax_exempt>\n  <address>\n    <address1>123 Main St.</address1>\n    <address2 nil=\"nil\"/>\n    <city>San Francisco</city>\n    <state>CA</state>\n    <zip>94105</zip>\n    <country>US</country>\n    <phone nil=\"nil\"/>\n  </address>\n  <accept_language nil=\"nil\"/>\n  <hosted_login_token>71c122cb16fc90252ff845eacf5d7814</hosted_login_token>\n  <created_at type=\"datetime\">2016-08-03T15:44:05Z</created_at>\n  <updated_at type=\"datetime\">2016-08-03T16:30:50Z</updated_at>\n  <closed_at nil=\"nil\"/>\n</account>","language":"xml","status":200}]},"settings":"","url":"/accounts/:account_code"},"body":"[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Please note\",\n  \"body\": \"You may optionally include billing information when updating an account. If the billing information is provided, the billing information will be validated. The account will only be updated if the billing information is valid.\"\n}\n[/block]","category":"578e7c59b434c30e0035bf2a","createdAt":"2015-06-15T21:57:38.556Z","excerpt":"Updates an existing account.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"update-account","sync_unique":"","title":"Update Account","type":"put","updates":["568ffb69769f210d00132584"],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

putUpdate Account

Updates an existing account.

account_code:
required
string
Account's unique code.
username:
string
The username for the account, ignore if you do not use usernames. Max of 255 characters.
email:
string
The email address for the account.
first_name:
string
The first name for the account. Max of 255 characters.
last_name:
string
The last name for the account. Max of 255 characters.
company_name:
string
The company name for the account. Max of 255 characters.
vat_number:
string
The VAT number to avoid having the VAT applied (if applicable).
tax_exempt:
boolean
The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.
entity_use_code:
string
The Avalara AvaTax value that can be passed to identify the customer type for tax purposes. The range of values can be A - R (more info at Avalara). Value is case-sensitive.
billing_info:
object
The nested billing information. If present, the account will only be created after the billing information is validated.
address:
object
The nested address information for the account: `address1`, `address2`, `city`, `state`, `zip`, `country`, `phone`.
accept_language:
string
The ISO 639-1 language code from the user's browser, indicating their preferred language and locale.
cc_emails:
array of strings
Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.

Please note

You may optionally include billing information when updating an account. If the billing information is provided, the billing information will be validated. The account will only be updated if the billing information is valid.

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php

try {
  $account = Recurly_Account::get('b6f5783');
  $account->company_name = 'New Company Name';
  $account->update();

  print "Account: $account\n";
} catch (Recurly_NotFoundError $e) {
  print "Invalid account code: $e";
}
account = Recurly::Account.find('account_1')
account.company_name = 'New Company Name'
account.save
account = Account.get('account_1')
account.company_name = 'New Company Name'
account.save()
var account = Account.Get("account_1");
account.CompanyName = 'New Company Name'
account.Update();
<account>
  <company_name>New Company Name</company_name>
</account>

Result Format

<account href="https://your-subdomain.recurly.com/v2/accounts/1">
  <adjustments href="https://your-subdomain.recurly.com/v2/accounts/1/adjustments"/>
  <account_balance href="https://your-subdomain.recurly.com/v2/accounts/1/balance"/>
  <billing_info href="https://your-subdomain.recurly.com/v2/accounts/1/billing_info"/>
  <invoices href="https://your-subdomain.recurly.com/v2/accounts/1/invoices"/>
  <redemptions href="https://your-subdomain.recurly.com/v2/accounts/1/redemptions"/>
  <subscriptions href="https://your-subdomain.recurly.com/v2/accounts/1/subscriptions"/>
  <transactions href="https://your-subdomain.recurly.com/v2/accounts/1/transactions"/>
  <account_code>1</account_code>
  <state>active</state>
  <username>verena1234</username>
  <email>verena@example.com</email>
  <cc_emails>bob@example.com,susan@example.com</cc_emails>
  <first_name>Verena</first_name>
  <last_name>Example</last_name>
  <company_name>New Company Name</company_name>
  <vat_number nil="nil"/>
  <tax_exempt type="boolean">false</tax_exempt>
  <address>
    <address1>123 Main St.</address1>
    <address2 nil="nil"/>
    <city>San Francisco</city>
    <state>CA</state>
    <zip>94105</zip>
    <country>US</country>
    <phone nil="nil"/>
  </address>
  <accept_language nil="nil"/>
  <hosted_login_token>71c122cb16fc90252ff845eacf5d7814</hosted_login_token>
  <created_at type="datetime">2016-08-03T15:44:05Z</created_at>
  <updated_at type="datetime">2016-08-03T16:30:50Z</updated_at>
  <closed_at nil="nil"/>
</account>


{"__v":0,"_id":"578e7c5ab434c30e0035bf81","api":{"examples":{"codes":[{"name":"","code":"<?php\n\ntry {\n  $account = Recurly_Account::get('b6f5783');\n  $account->close();\n\n  print \"Account: $account\";\n} catch (Recurly_NotFoundError $e) {\n  print \"Invalid account code: $e\";\n}","language":"php"},{"code":"account = Recurly::Account.find('1')\naccount.destroy","language":"ruby"},{"code":"account = Account.get('1')\naccount.delete()","language":"python"},{"code":"var account = Accounts.Get(\"1\");\naccount.Close();","language":"csharp"}]},"results":{"codes":[{"name":"","code":"","language":"xml","status":200}]},"settings":"","auth":"required","params":[{"_id":"55944ebb5c9eaa2300a86337","ref":"","in":"path","required":true,"desc":"Account's unique code.","default":"","type":"string","name":"account_code"}],"url":"/accounts/:account_code"},"body":"[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Please note\",\n  \"body\": \"Closing an account permanently deletes its billing information and cancels any active subscriptions (canceled subscriptions will remain active until the end of the current billing cycle before expiring).\"\n}\n[/block]","category":"578e7c59b434c30e0035bf2a","createdAt":"2015-06-15T22:00:42.004Z","excerpt":"Marks an account as closed and cancels any active subscriptions.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"close-account","sync_unique":"","title":"Close Account","type":"delete","updates":[],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

deleteClose Account

Marks an account as closed and cancels any active subscriptions.

account_code:
required
string
Account's unique code.

Please note

Closing an account permanently deletes its billing information and cancels any active subscriptions (canceled subscriptions will remain active until the end of the current billing cycle before expiring).

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php

try {
  $account = Recurly_Account::get('b6f5783');
  $account->close();

  print "Account: $account";
} catch (Recurly_NotFoundError $e) {
  print "Invalid account code: $e";
}
account = Recurly::Account.find('1')
account.destroy
account = Account.get('1')
account.delete()
var account = Accounts.Get("1");
account.Close();


{"__v":0,"_id":"578e7c5ab434c30e0035bf82","api":{"auth":"required","examples":{"codes":[{"name":"","code":"<?php\n\ntry {\n  $account = Recurly_Account::get('b6f5783');\n  $account->reopen();\n\n  // Or to fetch and reopen in one call\n  // $account = Recurly_Account::reopenAccount('b6f5783');\n\n  print \"Account: $account\";\n} catch (Recurly_NotFoundError $e) {\n  print \"Invalid account code: $e\";\n} catch (Recurly_ValidationError $e) {\n  print \"Account already open: $e\";\n}","language":"php"},{"code":"account = Recurly::Account.find '1'\naccount.reopen","language":"ruby"},{"code":"account = Account.get('1')\naccount.reopen() ","language":"python"},{"code":"var account = Accounts.Get(\"1\");\naccount.Reopen();","language":"csharp"}]},"params":[{"_id":"55944ed45c9eaa2300a86339","ref":"","in":"path","required":true,"desc":"Account's unique code.","default":"","type":"string","name":"account_code"}],"results":{"codes":[{"status":200,"language":"xml","code":"<account href=\"https://your-subdomain.recurly.com/v2/accounts/1\">\n  <adjustments href=\"https://your-subdomain.recurly.com/v2/accounts/1/adjustments\"/>\n  <account_balance href=\"https://your-subdomain.recurly.com/v2/accounts/1/balance\"/>\n  <invoices href=\"https://your-subdomain.recurly.com/v2/accounts/1/invoices\"/>\n  <redemptions href=\"https://your-subdomain.recurly.com/v2/accounts/1/redemptions\"/>\n  <subscriptions href=\"https://your-subdomain.recurly.com/v2/accounts/1/subscriptions\"/>\n  <transactions href=\"https://your-subdomain.recurly.com/v2/accounts/1/transactions\"/>\n  <account_code>1</account_code>\n  <state>active</state>\n  <username>verena1234</username>\n  <email>verena@example.com</email>\n  <cc_emails>bob@example.com,susan@example.com</cc_emails>\n  <first_name>Verena</first_name>\n  <last_name>Example</last_name>\n  <company_name>New Company Name</company_name>\n  <vat_number nil=\"nil\"/>\n  <tax_exempt type=\"boolean\">false</tax_exempt>\n  <address>\n    <address1>123 Main St.</address1>\n    <address2 nil=\"nil\"/>\n    <city>San Francisco</city>\n    <state>CA</state>\n    <zip>94105</zip>\n    <country>US</country>\n    <phone nil=\"nil\"/>\n  </address>\n  <accept_language nil=\"nil\"/>\n  <hosted_login_token>71c122cb16fc90252ff845eacf5d7814</hosted_login_token>\n  <created_at type=\"datetime\">2016-08-03T15:44:05Z</created_at>\n  <updated_at type=\"datetime\">2016-08-03T16:31:25Z</updated_at>\n  <closed_at nil=\"nil\"/>\n</account>","name":""}]},"settings":"","url":"/accounts/:account_code/reopen"},"body":"[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Please note\",\n  \"body\": \"Editing an account, creating an account with the same `account_code` as the deleted account, or creating a new transaction or subscription will also reopen an account. Reopening an account will restore its history. Reopening an account does not modify any previously canceled or expired subscriptions and billing information will need to be provided by the customer to continue billing.\"\n}\n[/block]","category":"578e7c59b434c30e0035bf2a","createdAt":"2015-06-15T22:03:14.174Z","excerpt":"Transitions a closed account back to active.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":6,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"reopen-account","sync_unique":"","title":"Reopen Account","type":"put","updates":[],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

putReopen Account

Transitions a closed account back to active.

account_code:
required
string
Account's unique code.

Please note

Editing an account, creating an account with the same account_code as the deleted account, or creating a new transaction or subscription will also reopen an account. Reopening an account will restore its history. Reopening an account does not modify any previously canceled or expired subscriptions and billing information will need to be provided by the customer to continue billing.

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php

try {
  $account = Recurly_Account::get('b6f5783');
  $account->reopen();

  // Or to fetch and reopen in one call
  // $account = Recurly_Account::reopenAccount('b6f5783');

  print "Account: $account";
} catch (Recurly_NotFoundError $e) {
  print "Invalid account code: $e";
} catch (Recurly_ValidationError $e) {
  print "Account already open: $e";
}
account = Recurly::Account.find '1'
account.reopen
account = Account.get('1')
account.reopen() 
var account = Accounts.Get("1");
account.Reopen();

Result Format

<account href="https://your-subdomain.recurly.com/v2/accounts/1">
  <adjustments href="https://your-subdomain.recurly.com/v2/accounts/1/adjustments"/>
  <account_balance href="https://your-subdomain.recurly.com/v2/accounts/1/balance"/>
  <invoices href="https://your-subdomain.recurly.com/v2/accounts/1/invoices"/>
  <redemptions href="https://your-subdomain.recurly.com/v2/accounts/1/redemptions"/>
  <subscriptions href="https://your-subdomain.recurly.com/v2/accounts/1/subscriptions"/>
  <transactions href="https://your-subdomain.recurly.com/v2/accounts/1/transactions"/>
  <account_code>1</account_code>
  <state>active</state>
  <username>verena1234</username>
  <email>verena@example.com</email>
  <cc_emails>bob@example.com,susan@example.com</cc_emails>
  <first_name>Verena</first_name>
  <last_name>Example</last_name>
  <company_name>New Company Name</company_name>
  <vat_number nil="nil"/>
  <tax_exempt type="boolean">false</tax_exempt>
  <address>
    <address1>123 Main St.</address1>
    <address2 nil="nil"/>
    <city>San Francisco</city>
    <state>CA</state>
    <zip>94105</zip>
    <country>US</country>
    <phone nil="nil"/>
  </address>
  <accept_language nil="nil"/>
  <hosted_login_token>71c122cb16fc90252ff845eacf5d7814</hosted_login_token>
  <created_at type="datetime">2016-08-03T15:44:05Z</created_at>
  <updated_at type="datetime">2016-08-03T16:31:25Z</updated_at>
  <closed_at nil="nil"/>
</account>


{"__v":2,"_id":"578e84deb434c30e0035bfdb","api":{"auth":"required","examples":{"codes":[]},"params":[{"_id":"578e888a36baeb17003fd5fb","default":"","desc":"Account's unique code.","in":"query","name":"account_code","ref":"","required":true,"type":"string"}],"results":{"codes":[{"status":200,"language":"xml","code":"<account_balance href=\"https://your-subdomain.recurly.com/v2/accounts/1/balance\">\n  <account href=\"https://your-subdomain.recurly.com/v2/accounts/1\"/>\n  <past_due type=\"boolean\">false</past_due>\n  <balance_in_cents>\n    <USD type=\"integer\">3000</USD>\n    <EUR type=\"integer\">0</EUR>\n  </balance_in_cents>\n</account_balance>","name":""},{"status":400,"language":"json","code":"<error>\n  <symbol>unavailable_in_api_version</symbol>\n  <description>This request cannot be completed using this version of the API. It was added in version '2.3'.</description>\n</error>","name":""},{"status":404,"language":"text","code":"<error>\n  <symbol>not_found</symbol>\n  <description lang=\"en-US\">Couldn't find Account with account_code = not-1</description>\n</error>"}]},"settings":"","url":"/accounts/:account_code/balance"},"body":"","category":"578e7c59b434c30e0035bf2a","createdAt":"2016-07-19T19:51:58.991Z","excerpt":"Returns the account's past due status and balance in each of the site's supported currencies.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":7,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"lookup-account-balance","sync_unique":"","title":"Lookup Account Balance","type":"get","updates":[],"user":"559d85d26b21311700fb0b7b","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

getLookup Account Balance

Returns the account's past due status and balance in each of the site's supported currencies.

account_code:
required
string
Account's unique code.

Definition

{{ api_url }}{{ page_api_url }}

Result Format

<account_balance href="https://your-subdomain.recurly.com/v2/accounts/1/balance">
  <account href="https://your-subdomain.recurly.com/v2/accounts/1"/>
  <past_due type="boolean">false</past_due>
  <balance_in_cents>
    <USD type="integer">3000</USD>
    <EUR type="integer">0</EUR>
  </balance_in_cents>
</account_balance>
<error>
  <symbol>unavailable_in_api_version</symbol>
  <description>This request cannot be completed using this version of the API. It was added in version '2.3'.</description>
</error>
<error>
  <symbol>not_found</symbol>
  <description lang="en-US">Couldn't find Account with account_code = not-1</description>
</error>


{"__v":1,"_id":"578e7c5ab434c30e0035bf83","api":{"auth":"required","examples":{"codes":[{"name":"","code":"<?php\n\ntry {\n  $notes = Recurly_NoteList::get('b6f5783');\n  foreach ($notes as $note) {\n    print \"Note: {$note->message}\\n\";\n  }\n} catch (Recurly_NotFoundError $e) {\n  print \"Invalid account code: $e\";\n}","language":"php"},{"code":"try:\n  account = Account.get('1')\n  for note in account.notes():\n   print \"Note: %s\" % note.message\nexcept NotFoundError:\n  print \"Account not found.\\n\"","language":"python"},{"code":"using System.Linq;\n\nvar account = Accounts.Get(\"1\");\nvar notes = account.GetNotes();\nwhile (notes.Any())\n{\n\tforeach (var note in notes)\n\t\tConsole.WriteLine(\"Note: \" + note.Message);\n\tnotes = notes.Next;\n}","language":"csharp"}]},"params":[{"_id":"55944eddccc3052300569882","ref":"","in":"path","required":true,"desc":"Account's unique code.","default":"","type":"string","name":"account_code"},{"_id":"5783c946ce802f0e0087d4bb","ref":"","in":"query","required":false,"desc":"Splits records across pages. Leave blank to return the first page. Follow the URI in the first page's Link header to fetch the next page.","default":"","type":"string","name":"cursor"},{"_id":"578ea620c93aac0e00ec889d","ref":"","in":"query","required":false,"desc":"The attribute that will be used to order records: `created_at`, `updated_at`.","default":"created_at","type":"string","name":"sort"},{"_id":"578ea620c93aac0e00ec889c","ref":"","in":"query","required":false,"desc":"The order in which products will be returned: `asc` for ascending order, `desc` for descending order.","default":"desc","type":"string","name":"order"},{"_id":"578ea620c93aac0e00ec889b","ref":"","in":"query","required":false,"desc":"Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes greater than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.","default":"","type":"datetime","name":"begin_time"},{"_id":"578ea620c93aac0e00ec889a","ref":"","in":"query","required":false,"desc":"","default":"","type":"datetime","name":"end_time"},{"_id":"5783c946ce802f0e0087d4ba","ref":"","in":"query","required":false,"desc":"Number of records to return per page, up to a maximum of 200.","default":"50","type":"int","name":"per_page"}],"results":{"codes":[{"name":"","code":"<notes type=\"array\">\n  <note>\n    <account href=\"https://your-subdomain.recurly.com/v2/accounts/1\"/>\n    <message>This is my second note</message>\n    <created_at type=\"datetime\">2015-06-14T16:08:41Z</created_at>\n  </note>\n  <note>\n    <account href=\"https://your-subdomain.recurly.com/v2/accounts/1\"/>\n    <message>This is my first note</message>\n    <created_at type=\"datetime\">2016-06-13T16:06:21Z</created_at>\n  </note>\n  <!-- Continued... -->\n</notes>","language":"xml","status":200}]},"settings":"","url":"/accounts/:account_code/notes"},"body":"","category":"578e7c59b434c30e0035bf2a","createdAt":"2015-06-15T22:04:40.352Z","excerpt":"Returns a list of the notes on an account sorted in descending order (most recently created first).","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":8,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"list-account-notes","sync_unique":"","title":"List Account Notes","type":"get","updates":[],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

getList Account Notes

Returns a list of the notes on an account sorted in descending order (most recently created first).

account_code:
required
string
Account's unique code.
cursor:
string
Splits records across pages. Leave blank to return the first page. Follow the URI in the first page's Link header to fetch the next page.
sort:
stringcreated_at
The attribute that will be used to order records: `created_at`, `updated_at`.
order:
stringdesc
The order in which products will be returned: `asc` for ascending order, `desc` for descending order.
begin_time:
datetime
Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes greater than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.
end_time:
datetime
per_page:
integer50
Number of records to return per page, up to a maximum of 200.

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php

try {
  $notes = Recurly_NoteList::get('b6f5783');
  foreach ($notes as $note) {
    print "Note: {$note->message}\n";
  }
} catch (Recurly_NotFoundError $e) {
  print "Invalid account code: $e";
}
try:
  account = Account.get('1')
  for note in account.notes():
   print "Note: %s" % note.message
except NotFoundError:
  print "Account not found.\n"
using System.Linq;

var account = Accounts.Get("1");
var notes = account.GetNotes();
while (notes.Any())
{
	foreach (var note in notes)
		Console.WriteLine("Note: " + note.Message);
	notes = notes.Next;
}

Result Format

<notes type="array">
  <note>
    <account href="https://your-subdomain.recurly.com/v2/accounts/1"/>
    <message>This is my second note</message>
    <created_at type="datetime">2015-06-14T16:08:41Z</created_at>
  </note>
  <note>
    <account href="https://your-subdomain.recurly.com/v2/accounts/1"/>
    <message>This is my first note</message>
    <created_at type="datetime">2016-06-13T16:06:21Z</created_at>
  </note>
  <!-- Continued... -->
</notes>


{"__v":0,"_id":"578e7c59b434c30e0035bf4e","api":{"auth":"required","examples":{"codes":[]},"params":[{"_id":"55f8905559eace0d0087dc69","ref":"","in":"query","required":false,"desc":"The type of adjustment to return: `charge` or `credit`.","default":"","type":"string","name":"type"},{"_id":"55f88d0560cc850d008a7bae","ref":"","in":"query","required":false,"desc":"The URL of the account for the specified adjustment.","default":"","type":"string","name":"account"},{"_id":"55f88d0560cc850d008a7bad","ref":"","in":"query","required":false,"desc":"The URL of the invoice for the specified adjustment.","default":"","type":"string","name":"invoice"},{"_id":"55f88d0560cc850d008a7bac","ref":"","in":"query","required":false,"desc":"The unique identifier of the adjustment.","default":"","type":"string","name":"uuid"},{"_id":"55f88d0560cc850d008a7bab","ref":"","in":"query","required":false,"desc":"The state of the adjustments to return: `pending` or `invoiced`.","default":"","type":"string","name":"state"},{"_id":"55f88d0560cc850d008a7baa","ref":"","in":"query","required":false,"desc":"Description of the adjustment for the adjustment. Max 255 characters.","default":"","type":"string","name":"description"},{"_id":"55f88d0560cc850d008a7ba9","ref":"","in":"query","required":false,"desc":"Accounting code. Max of 20 characters.","default":"","type":"string","name":"accounting_code"},{"_id":"55f88d0560cc850d008a7ba8","ref":"","in":"query","required":false,"desc":"The origin of the adjustment to return: `plan`, `plan_trial`, `setup_fee`, `add_on`, `add_on_trial`, `one_time`, `debit`, `credit`, `coupon`, or `carryforward`.","default":"","type":"string","name":"origin"},{"_id":"55f88d0560cc850d008a7ba7","ref":"","in":"query","required":false,"desc":"Positive amount for a charge, negative amount for a credit. Max 10000000.","default":"","type":"int","name":"unit_amount_in_cents"},{"_id":"55f88d0560cc850d008a7ba6","ref":"","in":"query","required":false,"desc":"Quantity.","default":"1","type":"string","name":"quantity"},{"_id":"55f88d0560cc850d008a7ba5","ref":"","in":"query","required":false,"desc":"Only shows if adjustment is a credit created from another credit.","default":"","type":"string","name":"original_adjustment_uuid"},{"_id":"55f88d0560cc850d008a7ba4","ref":"","in":"query","required":false,"desc":"The discount on the adjustment, in cents.","default":"","type":"int","name":"discount_in_cents"},{"_id":"55f88d0560cc850d008a7ba3","ref":"","in":"query","required":false,"desc":"The tax on the adjustment, in cents.","default":"","type":"int","name":"tax_in_cents"},{"_id":"55f88d0560cc850d008a7ba2","ref":"","in":"query","required":false,"desc":"The total amount of the adjustment, in cents.","default":"","type":"int","name":"total_in_cents"},{"_id":"55f88d0560cc850d008a7ba1","ref":"","in":"query","required":false,"desc":"Currency, 3-letter ISO code.","default":"","type":"string","name":"currency"},{"_id":"55f88d0560cc850d008a7ba0","ref":"","in":"query","required":false,"desc":"`true` if the current adjustment is taxable, `false` if it is not.","default":"","type":"boolean","name":"taxable"},{"_id":"55f88d0560cc850d008a7b9f","ref":"","in":"query","required":false,"desc":"The tax type of the adjustment.","default":"","type":"string","name":"tax_type"},{"_id":"55f88d0560cc850d008a7b9e","ref":"","in":"query","required":false,"desc":"The tax region of the adjustment.","default":"","type":"string","name":"tax_region"},{"_id":"55f88d0560cc850d008a7b9d","ref":"","in":"query","required":false,"desc":"The tax rate of the adjustment.","default":"","type":"string","name":"tax_rate"},{"_id":"55f88d0560cc850d008a7b9c","ref":"","in":"query","required":false,"desc":"`true` exempts tax on the charge, `false` applies tax on the charge. If not defined, then defaults to the Plan and Site settings. This attribute does not work for credits (negative adjustments). Credits are always post-tax. Pre-tax discounts should use the Coupons feature.","default":"","type":"boolean","name":"tax_exempt"},{"_id":"55f88d0560cc850d008a7b9b","ref":"","in":"query","required":false,"desc":"The nested address information of the adjustment: `name `, `type`, `tax_rate`, `tax_in_cents`.","default":"","type":"array_mixed","name":"tax_details"},{"_id":"55f88d2bb089b71700a8363c","ref":"","in":"query","required":false,"desc":"Optional field for EU VAT merchants and Avalara AvaTax Pro merchants. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`. If you have your own AvaTax account configured, you can use Avalara tax codes to assign custom tax rules.","default":"","type":"string","name":"tax_code"},{"_id":"55f88d0560cc850d008a7b9a","ref":"","in":"query","required":false,"desc":"A timestamp associated with when the adjustment began.","default":"Today","type":"datetime","name":"start_date"},{"_id":"55f88d0560cc850d008a7b99","ref":"","in":"query","required":false,"desc":"A timestamp associated with when the adjustment ended.","default":"","type":"datetime","name":"end_date"},{"_id":"55f88d0560cc850d008a7b98","ref":"","in":"query","required":false,"desc":"A timestamp associated with when the adjustment was created.","default":"","type":"datetime","name":"created_at"}],"results":{"codes":[{"status":200,"language":"xml","code":"<adjustment href=\"https://your-subdomain.recurly.com/v2/adjustments/37bff9dd3ec90471cf62bd4f6f80db3d\" type=\"charge\">\n  <account href=\"https://your-subdomain.recurly.com/v2/accounts/1\"/>\n  <invoice href=\"https://your-subdomain.recurly.com/v2/invoices/1006\"/>\n  <subscription href=\"https://your-subdomain.recurly.com/v2/subscriptions/37bfef7a8e44cfc3817b7a43eba8a6e6\"/>\n  <uuid>37bff9dd3ec90471cf62bd4f6f80db3d</uuid>\n  <state>invoiced</state>\n  <description>Refund for Setup fee: Gold plan</description>\n  <accounting_code nil=\"nil\"/>\n  <product_code>gold</product_code>\n  <origin>setup_fee</origin>\n  <unit_amount_in_cents type=\"integer\">800</unit_amount_in_cents>\n  <quantity type=\"integer\">-1</quantity>\n  <quantity_remaining type=\"integer\">0</quantity_remaining>\n  <original_adjustment_uuid>37bfef7af3cd23ee89d77a435aa1838d</original_adjustment_uuid>\n  <discount_in_cents type=\"integer\">0</discount_in_cents>\n  <tax_in_cents type=\"integer\">-70</tax_in_cents>\n  <total_in_cents type=\"integer\">-870</total_in_cents>\n  <currency>EUR</currency>\n  <taxable type=\"boolean\">false</taxable>\n  <tax_type>usst</tax_type>\n  <tax_region>CA</tax_region>\n  <tax_rate type=\"float\">0.0875</tax_rate>\n  <tax_exempt type=\"boolean\">false</tax_exempt>\n  <tax_code nil=\"nil\"/>\n  <tax_details type=\"array\">\n    <tax_detail>\n      <name nil=\"nil\"/>\n      <type>state</type>\n      <tax_rate type=\"float\">0.065</tax_rate>\n      <tax_in_cents type=\"integer\">-52</tax_in_cents>\n    </tax_detail>\n    <tax_detail>\n      <name nil=\"nil\"/>\n      <type>county</type>\n      <tax_rate type=\"float\">0.01</tax_rate>\n      <tax_in_cents type=\"integer\">-8</tax_in_cents>\n    </tax_detail>\n    <tax_detail>\n      <name nil=\"nil\"/>\n      <type>city</type>\n      <tax_rate type=\"float\">0.0</tax_rate>\n      <tax_in_cents type=\"integer\">0</tax_in_cents>\n    </tax_detail>\n    <tax_detail>\n      <name nil=\"nil\"/>\n      <type>special</type>\n      <tax_rate type=\"float\">0.0125</tax_rate>\n      <tax_in_cents type=\"integer\">-10</tax_in_cents>\n    </tax_detail>\n  </tax_details>\n  <start_date type=\"datetime\">2016-08-03T16:02:24Z</start_date>\n  <end_date nil=\"nil\"/>\n  <created_at type=\"datetime\">2016-08-03T16:13:44Z</created_at>\n  <updated_at type=\"datetime\">2016-08-03T16:13:44Z</updated_at>\n  <revenue_schedule_type>evenly</revenue_schedule_type>\n</adjustment>","name":""}]},"settings":"","url":"/adjustments"},"body":"","category":"578e7c59b434c30e0035bf2b","createdAt":"2015-09-15T21:26:29.282Z","excerpt":"The history of your customer's Recurly account can be tracked through adjustments, made up of credits and charges.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"adjustment-object","sync_unique":"","title":"Adjustment Object","type":"get","updates":[],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

getAdjustment Object

The history of your customer's Recurly account can be tracked through adjustments, made up of credits and charges.

type:
string
The type of adjustment to return: `charge` or `credit`.
account:
string
The URL of the account for the specified adjustment.
invoice:
string
The URL of the invoice for the specified adjustment.
uuid:
string
The unique identifier of the adjustment.
state:
string
The state of the adjustments to return: `pending` or `invoiced`.
description:
string
Description of the adjustment for the adjustment. Max 255 characters.
accounting_code:
string
Accounting code. Max of 20 characters.
origin:
string
The origin of the adjustment to return: `plan`, `plan_trial`, `setup_fee`, `add_on`, `add_on_trial`, `one_time`, `debit`, `credit`, `coupon`, or `carryforward`.
unit_amount_in_cents:
integer
Positive amount for a charge, negative amount for a credit. Max 10000000.
quantity:
string1
Quantity.
original_adjustment_uuid:
string
Only shows if adjustment is a credit created from another credit.
discount_in_cents:
integer
The discount on the adjustment, in cents.
tax_in_cents:
integer
The tax on the adjustment, in cents.
total_in_cents:
integer
The total amount of the adjustment, in cents.
currency:
string
Currency, 3-letter ISO code.
taxable:
boolean
`true` if the current adjustment is taxable, `false` if it is not.
tax_type:
string
The tax type of the adjustment.
tax_region:
string
The tax region of the adjustment.
tax_rate:
string
The tax rate of the adjustment.
tax_exempt:
boolean
`true` exempts tax on the charge, `false` applies tax on the charge. If not defined, then defaults to the Plan and Site settings. This attribute does not work for credits (negative adjustments). Credits are always post-tax. Pre-tax discounts should use the Coupons feature.
tax_details:
array of mixed
The nested address information of the adjustment: `name `, `type`, `tax_rate`, `tax_in_cents`.
tax_code:
string
Optional field for EU VAT merchants and Avalara AvaTax Pro merchants. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`. If you have your own AvaTax account configured, you can use Avalara tax codes to assign custom tax rules.
start_date:
datetimeToday
A timestamp associated with when the adjustment began.
end_date:
datetime
A timestamp associated with when the adjustment ended.
created_at:
datetime
A timestamp associated with when the adjustment was created.

Definition

{{ api_url }}{{ page_api_url }}

Result Format

<adjustment href="https://your-subdomain.recurly.com/v2/adjustments/37bff9dd3ec90471cf62bd4f6f80db3d" type="charge">
  <account href="https://your-subdomain.recurly.com/v2/accounts/1"/>
  <invoice href="https://your-subdomain.recurly.com/v2/invoices/1006"/>
  <subscription href="https://your-subdomain.recurly.com/v2/subscriptions/37bfef7a8e44cfc3817b7a43eba8a6e6"/>
  <uuid>37bff9dd3ec90471cf62bd4f6f80db3d</uuid>
  <state>invoiced</state>
  <description>Refund for Setup fee: Gold plan</description>
  <accounting_code nil="nil"/>
  <product_code>gold</product_code>
  <origin>setup_fee</origin>
  <unit_amount_in_cents type="integer">800</unit_amount_in_cents>
  <quantity type="integer">-1</quantity>
  <quantity_remaining type="integer">0</quantity_remaining>
  <original_adjustment_uuid>37bfef7af3cd23ee89d77a435aa1838d</original_adjustment_uuid>
  <discount_in_cents type="integer">0</discount_in_cents>
  <tax_in_cents type="integer">-70</tax_in_cents>
  <total_in_cents type="integer">-870</total_in_cents>
  <currency>EUR</currency>
  <taxable type="boolean">false</taxable>
  <tax_type>usst</tax_type>
  <tax_region>CA</tax_region>
  <tax_rate type="float">0.0875</tax_rate>
  <tax_exempt type="boolean">false</tax_exempt>
  <tax_code nil="nil"/>
  <tax_details type="array">
    <tax_detail>
      <name nil="nil"/>
      <type>state</type>
      <tax_rate type="float">0.065</tax_rate>
      <tax_in_cents type="integer">-52</tax_in_cents>
    </tax_detail>
    <tax_detail>
      <name nil="nil"/>
      <type>county</type>
      <tax_rate type="float">0.01</tax_rate>
      <tax_in_cents type="integer">-8</tax_in_cents>
    </tax_detail>
    <tax_detail>
      <name nil="nil"/>
      <type>city</type>
      <tax_rate type="float">0.0</tax_rate>
      <tax_in_cents type="integer">0</tax_in_cents>
    </tax_detail>
    <tax_detail>
      <name nil="nil"/>
      <type>special</type>
      <tax_rate type="float">0.0125</tax_rate>
      <tax_in_cents type="integer">-10</tax_in_cents>
    </tax_detail>
  </tax_details>
  <start_date type="datetime">2016-08-03T16:02:24Z</start_date>
  <end_date nil="nil"/>
  <created_at type="datetime">2016-08-03T16:13:44Z</created_at>
  <updated_at type="datetime">2016-08-03T16:13:44Z</updated_at>
  <revenue_schedule_type>evenly</revenue_schedule_type>
</adjustment>


{"__v":2,"_id":"578e7c59b434c30e0035bf4f","api":{"auth":"required","examples":{"codes":[{"name":"","code":"<?php\n\ntry {\n  $adjustments = Recurly_AdjustmentList::get('b6f5783');\n  foreach ($adjustments as $adjustment) {\n    print \"Adjustment: $adjustment\\n\";\n  }\n} catch (Recurly_NotFoundError $e) {\n  print \"Invalid account code: $e\";\n}","language":"php"},{"code":"account = Recurly::Account.find('1')\naccount.adjustments.find_each do |adjustment|\n  puts \"Adjustment: #{adjustment.inspect}\"\nend","language":"ruby"},{"code":"#client version 2.1.6+\naccount = Account.get('1')\nfor adjustment in account.adjustments():\n    print 'Adjustment: %s' % adjustment\n\n#client version <= 2.1.5\naccount = Account.get('1')\nadjustments = account.adjustments()\nwhile adjustments:\n    for adjustment in adjustments:\n        print 'Adjustment: %s' % adjustment\n    try:\n        adjustments = adjustments.next_page()\n    except PageError:\n        adjustments = ()","language":"python"},{"code":"using System.Linq;\n\nvar account = Accounts.Get(\"1\");\nvar adjustments = account.GetAdjustments();\nwhile (adjustments.Any())\n{\n\tforeach (var adjustment in adjustments)\n\t\tConsole.WriteLine(\"Adjustment: \" + adjustment);\n\tadjustments = adjustments.Next;\n}","language":"csharp"}]},"params":[{"_id":"5783c9a7192dcf0e0099828e","ref":"","in":"path","required":true,"desc":"Account's unique code.","default":"","type":"string","name":"account_code"},{"_id":"578ea67ec93aac0e00ec88a5","ref":"","in":"query","required":false,"desc":"The attribute that will be used to order records: `created_at`, `updated_at`.","default":"created_at","type":"string","name":"sort"},{"_id":"578ea67ec93aac0e00ec88a4","ref":"","in":"query","required":false,"desc":"The order in which products will be returned: `asc` for ascending order, `desc` for descending order.","default":"desc","type":"string","name":"order"},{"_id":"578ea67ec93aac0e00ec88a3","ref":"","in":"query","required":false,"desc":"Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes greater than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.","default":"","type":"datetime","name":"begin_time"},{"_id":"578ea67ec93aac0e00ec88a2","ref":"","in":"query","required":false,"desc":"Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes less than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.","default":"","type":"datetime","name":"end_time"},{"_id":"5783c9a7192dcf0e0099828c","ref":"","in":"query","required":false,"desc":"Number of records to return per page, up to a maximum of 200.","default":"50","type":"int","name":"per_page"},{"_id":"5783c9a7192dcf0e0099828d","ref":"","in":"query","required":false,"desc":"Splits records across pages. Leave blank to return the first page. Follow the URI in the first page's Link header to fetch the next page.","default":"","type":"string","name":"cursor"}],"results":{"codes":[{"name":"","code":"<adjustments type=\"array\">\n  <adjustment href=\"https://your-subdomain.recurly.com/v2/adjustments/37c0038fe1ffc9405019db4a11a99aa8\" type=\"credit\">\n    <account href=\"https://your-subdomain.recurly.com/v2/accounts/1\"/>\n    <uuid>37c0038fe1ffc9405019db4a11a99aa8</uuid>\n    <state>pending</state>\n    <description>Bonus for being a great customer</description>\n    <accounting_code nil=\"nil\"/>\n    <product_code nil=\"nil\"/>\n    <origin>credit</origin>\n    <unit_amount_in_cents type=\"integer\">-2000</unit_amount_in_cents>\n    <quantity type=\"integer\">1</quantity>\n    <discount_in_cents type=\"integer\">0</discount_in_cents>\n    <tax_in_cents type=\"integer\">0</tax_in_cents>\n    <total_in_cents type=\"integer\">-2000</total_in_cents>\n    <currency>USD</currency>\n    <taxable type=\"boolean\">false</taxable>\n    <tax_exempt type=\"boolean\">false</tax_exempt>\n    <tax_code nil=\"nil\"/>\n    <start_date type=\"datetime\">2016-08-03T16:24:20Z</start_date>\n    <end_date nil=\"nil\"/>\n    <created_at type=\"datetime\">2016-08-03T16:24:20Z</created_at>\n    <updated_at type=\"datetime\">2016-08-03T16:24:20Z</updated_at>\n    <revenue_schedule_type>at_invoice</revenue_schedule_type>\n  </adjustment>\n  <!-- Continued... -->\n</adjustments>","language":"xml","status":200}]},"settings":"","url":"/accounts/:account_code/adjustments"},"body":"","category":"578e7c59b434c30e0035bf2b","createdAt":"2015-06-15T22:21:48.674Z","excerpt":"Returns a list of adjustments for a given account. Results are ordered by the time created, sorted by newest first.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"list-an-accounts-adjustments","sync_unique":"","title":"List Account's Adjustments","type":"get","updates":[],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

getList Account's Adjustments

Returns a list of adjustments for a given account. Results are ordered by the time created, sorted by newest first.

account_code:
required
string
Account's unique code.
sort:
stringcreated_at
The attribute that will be used to order records: `created_at`, `updated_at`.
order:
stringdesc
The order in which products will be returned: `asc` for ascending order, `desc` for descending order.
begin_time:
datetime
Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes greater than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.
end_time:
datetime
Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes less than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.
per_page:
integer50
Number of records to return per page, up to a maximum of 200.
cursor:
string
Splits records across pages. Leave blank to return the first page. Follow the URI in the first page's Link header to fetch the next page.

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php

try {
  $adjustments = Recurly_AdjustmentList::get('b6f5783');
  foreach ($adjustments as $adjustment) {
    print "Adjustment: $adjustment\n";
  }
} catch (Recurly_NotFoundError $e) {
  print "Invalid account code: $e";
}
account = Recurly::Account.find('1')
account.adjustments.find_each do |adjustment|
  puts "Adjustment: #{adjustment.inspect}"
end
#client version 2.1.6+
account = Account.get('1')
for adjustment in account.adjustments():
    print 'Adjustment: %s' % adjustment

#client version <= 2.1.5
account = Account.get('1')
adjustments = account.adjustments()
while adjustments:
    for adjustment in adjustments:
        print 'Adjustment: %s' % adjustment
    try:
        adjustments = adjustments.next_page()
    except PageError:
        adjustments = ()
using System.Linq;

var account = Accounts.Get("1");
var adjustments = account.GetAdjustments();
while (adjustments.Any())
{
	foreach (var adjustment in adjustments)
		Console.WriteLine("Adjustment: " + adjustment);
	adjustments = adjustments.Next;
}

Result Format

<adjustments type="array">
  <adjustment href="https://your-subdomain.recurly.com/v2/adjustments/37c0038fe1ffc9405019db4a11a99aa8" type="credit">
    <account href="https://your-subdomain.recurly.com/v2/accounts/1"/>
    <uuid>37c0038fe1ffc9405019db4a11a99aa8</uuid>
    <state>pending</state>
    <description>Bonus for being a great customer</description>
    <accounting_code nil="nil"/>
    <product_code nil="nil"/>
    <origin>credit</origin>
    <unit_amount_in_cents type="integer">-2000</unit_amount_in_cents>
    <quantity type="integer">1</quantity>
    <discount_in_cents type="integer">0</discount_in_cents>
    <tax_in_cents type="integer">0</tax_in_cents>
    <total_in_cents type="integer">-2000</total_in_cents>
    <currency>USD</currency>
    <taxable type="boolean">false</taxable>
    <tax_exempt type="boolean">false</tax_exempt>
    <tax_code nil="nil"/>
    <start_date type="datetime">2016-08-03T16:24:20Z</start_date>
    <end_date nil="nil"/>
    <created_at type="datetime">2016-08-03T16:24:20Z</created_at>
    <updated_at type="datetime">2016-08-03T16:24:20Z</updated_at>
    <revenue_schedule_type>at_invoice</revenue_schedule_type>
  </adjustment>
  <!-- Continued... -->
</adjustments>


{"__v":26,"_id":"578e7c59b434c30e0035bf51","api":{"auth":"required","examples":{"codes":[{"name":"","code":"<?php\n\ntry {\n  $charge = new Recurly_Adjustment();\n  $charge->account_code = 'b6f5783';\n  $charge->description = 'Charge for extra bandwidth';\n  $charge->unit_amount_in_cents = 5000; // $50.00\n  $charge->currency = 'USD';\n  $charge->quantity = 1;\n  $charge->accounting_code = 'bandwidth';\n  $charge->tax_exempt = false;\n  $charge->create();\n\n  print \"Charge: $charge\";\n} catch (Recurly_NotFoundError $e) {\n  print \"Account not found: $e\";\n}","language":"php"},{"code":"account = Recurly::Account.find('1')\naccount.adjustments.create(\n  :description          => 'Charge for extra bandwidth',\n  :unit_amount_in_cents => 50_00,\n  :currency             => 'USD',\n  :quantity             => 1,\n  :accounting_code      => 'bandwidth',\n  :tax_exempt           => false\n)","language":"ruby"},{"code":"account = Account.get('1')\ncharge = Adjustment(\n  description='Charge for extra bandwidth',\n  unit_amount_in_cents=5000,\n  currency='USD',\n  quantity=1,\n  accounting_code='bandwidth',\n  tax_exempt=False\n)\naccount.charge(charge)","language":"python"},{"code":"var account = Accounts.Get(\"1\");\nvar adjustment = account.NewAdjustment(\n\t\"USD\",                        // currency\n\t5000,                         // unit_amount_in_cents\n\t\"Charge for extra bandwidth\", // description\n\t1,                            // quantity\n\t\"bandwidth\",                  // accounting_code\n\tfalse);                       // tax_exempt\nadjustment.Create();","language":"csharp"},{"code":"<adjustment>\n  <description>Charge for extra bandwidth</description>\n  <unit_amount_in_cents>5000</unit_amount_in_cents>\n  <currency>USD</currency>\n  <quantity>1</quantity>\n  <accounting_code>bandwidth</accounting_code>\n  <tax_exempt>false</tax_exempt>\n  <revenue_schedule_type>at_invoice</revenue_schedule_type>\n</adjustment>","language":"xml"}]},"params":[{"_id":"557f5188eb75d80d00af40a6","ref":"","in":"body","required":true,"desc":"Currency, 3-letter ISO code.","default":"","type":"string","name":"currency"},{"_id":"557f5188eb75d80d00af40a5","ref":"","in":"body","required":true,"desc":"Positive amount for a charge, negative amount for a credit. Max 10000000.","default":"","type":"string","name":"unit_amount_in_cents"},{"_id":"557f5188eb75d80d00af40a7","ref":"","in":"path","required":true,"desc":"Your unique account identifier.","default":"","type":"string","name":"account_code"},{"_id":"557f5188eb75d80d00af40a3","ref":"","in":"body","required":false,"desc":"Quantity.","default":"1","type":"int","name":"quantity"},{"_id":"557f5188eb75d80d00af40a4","ref":"","in":"body","required":false,"desc":"Description of the adjustment for the invoice.","default":"","type":"string","name":"description"},{"_id":"557f5188eb75d80d00af40a2","ref":"","in":"body","required":false,"desc":"Accounting code. Max of 20 characters.","default":"","type":"string","name":"accounting_code"},{"_id":"578f782bdbb58b0e00bbdf86","default":"","desc":"Optional field for setting a revenue schedule type. This will determine how revenue for the associated Charge should be recognized. When creating a Charge, if you supply an `end_date` and `end_date` available schedule types are `never`, `evenly`, `at_invoice`, `at_range_start`, or `at_range_end`. If you do not supply an `end_date` available schedule types are `never`, `at_range_end`, and `at_invoice`.","in":"body","name":"revenue_schedule_type","ref":"","required":false,"type":"string"},{"_id":"557f5188eb75d80d00af40a1","ref":"","in":"body","required":false,"desc":"`true` exempts tax on the charge, `false` applies tax on the charge. If not defined, then defaults to the Plan and Site settings. This attribute does not work for credits (negative adjustments). Credits are always post-tax. Pre-tax discounts should use the Coupons feature.","default":"","type":"boolean","name":"tax_exempt"},{"_id":"557f5188eb75d80d00af40a0","ref":"","in":"body","required":false,"desc":"Optional field for EU VAT merchants and Avalara AvaTax Pro merchants. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`. If you have your own AvaTax account configured, you can use Avalara tax codes to assign custom tax rules.","default":"","type":"string","name":"tax_code"},{"_id":"55e09fbfa44fae0d0021473e","ref":"","in":"body","required":false,"desc":"A timestamp associated with when the charge began.","default":"now","type":"timestamp","name":"start_date"},{"_id":"55e09fbfa44fae0d0021473d","ref":"","in":"body","required":false,"desc":"A timestamp associated with when the charge ended.","default":"","type":"timestamp","name":"end_date"}],"results":{"codes":[{"name":"","code":"<adjustment href=\"https://your-subdomain.recurly.com/v2/adjustments/37c0031340577f993ff30b41738f52ff\" type=\"charge\">\n  <account href=\"https://your-subdomain.recurly.com/v2/accounts/1\"/>\n  <uuid>37c0031340577f993ff30b41738f52ff</uuid>\n  <state>pending</state>\n  <description>Charge for extra bandwidth</description>\n  <accounting_code>bandwidth</accounting_code>\n  <product_code nil=\"nil\"/>\n  <origin>debit</origin>\n  <unit_amount_in_cents type=\"integer\">5000</unit_amount_in_cents>\n  <quantity type=\"integer\">1</quantity>\n  <discount_in_cents type=\"integer\">0</discount_in_cents>\n  <tax_in_cents type=\"integer\">0</tax_in_cents>\n  <total_in_cents type=\"integer\">5000</total_in_cents>\n  <currency>USD</currency>\n  <taxable type=\"boolean\">false</taxable>\n  <tax_exempt type=\"boolean\">false</tax_exempt>\n  <tax_code nil=\"nil\"/>\n  <start_date type=\"datetime\">2016-08-03T16:23:48Z</start_date>\n  <end_date nil=\"nil\"/>\n  <created_at type=\"datetime\">2016-08-03T16:23:48Z</created_at>\n  <updated_at type=\"datetime\">2016-08-03T16:23:48Z</updated_at>\n  <revenue_schedule_type>at_invoice</revenue_schedule_type>\n</adjustment>","language":"xml","status":201}]},"settings":"","url":"/accounts/:account_code/adjustments"},"body":"","category":"578e7c59b434c30e0035bf2b","createdAt":"2015-06-15T22:28:24.162Z","excerpt":"Creates a one-time charge on an account. Charges are not invoiced or collected immediately. Non-invoiced charges will automatically be invoices when the account's subscription renews, or you trigger a collection by posting an invoice. Charges may be removed from an account if they have not been invoiced.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"create-a-charge","sync_unique":"","title":"Create Charge","type":"post","updates":["55b2f1b5a96deb1900990c6f","565dc7d277f0090d0058196c"],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

postCreate Charge

Creates a one-time charge on an account. Charges are not invoiced or collected immediately. Non-invoiced charges will automatically be invoices when the account's subscription renews, or you trigger a collection by posting an invoice. Charges may be removed from an account if they have not been invoiced.

currency:
required
string
Currency, 3-letter ISO code.
unit_amount_in_cents:
required
string
Positive amount for a charge, negative amount for a credit. Max 10000000.
account_code:
required
string
Your unique account identifier.
quantity:
integer1
Quantity.
description:
string
Description of the adjustment for the invoice.
accounting_code:
string
Accounting code. Max of 20 characters.
revenue_schedule_type:
string
Optional field for setting a revenue schedule type. This will determine how revenue for the associated Charge should be recognized. When creating a Charge, if you supply an `end_date` and `end_date` available schedule types are `never`, `evenly`, `at_invoice`, `at_range_start`, or `at_range_end`. If you do not supply an `end_date` available schedule types are `never`, `at_range_end`, and `at_invoice`.
tax_exempt:
boolean
`true` exempts tax on the charge, `false` applies tax on the charge. If not defined, then defaults to the Plan and Site settings. This attribute does not work for credits (negative adjustments). Credits are always post-tax. Pre-tax discounts should use the Coupons feature.
tax_code:
string
Optional field for EU VAT merchants and Avalara AvaTax Pro merchants. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`. If you have your own AvaTax account configured, you can use Avalara tax codes to assign custom tax rules.
start_date:
timestampnow
A timestamp associated with when the charge began.
end_date:
timestamp
A timestamp associated with when the charge ended.

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php

try {
  $charge = new Recurly_Adjustment();
  $charge->account_code = 'b6f5783';
  $charge->description = 'Charge for extra bandwidth';
  $charge->unit_amount_in_cents = 5000; // $50.00
  $charge->currency = 'USD';
  $charge->quantity = 1;
  $charge->accounting_code = 'bandwidth';
  $charge->tax_exempt = false;
  $charge->create();

  print "Charge: $charge";
} catch (Recurly_NotFoundError $e) {
  print "Account not found: $e";
}
account = Recurly::Account.find('1')
account.adjustments.create(
  :description          => 'Charge for extra bandwidth',
  :unit_amount_in_cents => 50_00,
  :currency             => 'USD',
  :quantity             => 1,
  :accounting_code      => 'bandwidth',
  :tax_exempt           => false
)
account = Account.get('1')
charge = Adjustment(
  description='Charge for extra bandwidth',
  unit_amount_in_cents=5000,
  currency='USD',
  quantity=1,
  accounting_code='bandwidth',
  tax_exempt=False
)
account.charge(charge)
var account = Accounts.Get("1");
var adjustment = account.NewAdjustment(
	"USD",                        // currency
	5000,                         // unit_amount_in_cents
	"Charge for extra bandwidth", // description
	1,                            // quantity
	"bandwidth",                  // accounting_code
	false);                       // tax_exempt
adjustment.Create();
<adjustment>
  <description>Charge for extra bandwidth</description>
  <unit_amount_in_cents>5000</unit_amount_in_cents>
  <currency>USD</currency>
  <quantity>1</quantity>
  <accounting_code>bandwidth</accounting_code>
  <tax_exempt>false</tax_exempt>
  <revenue_schedule_type>at_invoice</revenue_schedule_type>
</adjustment>

Result Format

<adjustment href="https://your-subdomain.recurly.com/v2/adjustments/37c0031340577f993ff30b41738f52ff" type="charge">
  <account href="https://your-subdomain.recurly.com/v2/accounts/1"/>
  <uuid>37c0031340577f993ff30b41738f52ff</uuid>
  <state>pending</state>
  <description>Charge for extra bandwidth</description>
  <accounting_code>bandwidth</accounting_code>
  <product_code nil="nil"/>
  <origin>debit</origin>
  <unit_amount_in_cents type="integer">5000</unit_amount_in_cents>
  <quantity type="integer">1</quantity>
  <discount_in_cents type="integer">0</discount_in_cents>
  <tax_in_cents type="integer">0</tax_in_cents>
  <total_in_cents type="integer">5000</total_in_cents>
  <currency>USD</currency>
  <taxable type="boolean">false</taxable>
  <tax_exempt type="boolean">false</tax_exempt>
  <tax_code nil="nil"/>
  <start_date type="datetime">2016-08-03T16:23:48Z</start_date>
  <end_date nil="nil"/>
  <created_at type="datetime">2016-08-03T16:23:48Z</created_at>
  <updated_at type="datetime">2016-08-03T16:23:48Z</updated_at>
  <revenue_schedule_type>at_invoice</revenue_schedule_type>
</adjustment>


{"__v":44,"_id":"578e7c59b434c30e0035bf52","api":{"auth":"required","examples":{"codes":[{"language":"php","code":"<?php\n\n$credit = new Recurly_Adjustment();\n$credit->account_code = '1';\n$credit->description = 'Bonus for being a great customer';\n$credit->unit_amount_in_cents = -2000; // Negative $20.00.\n$credit->currency = 'USD';\n$credit->quantity = 1;\n$credit->create();","name":""},{"language":"ruby","code":"account = Recurly::Account.find('1')\naccount.adjustments.create(\n  :description          => 'Bonus for being a great customer',\n  :unit_amount_in_cents => -20_00,\n  :currency             => 'USD',\n  :quantity             => 1\n)"},{"language":"python","code":"account = Account.get('1')\ncredit = Adjustment(\n  description='Bonus for being a great customer',\n  unit_amount_in_cents=-2000,\n  currency='USD',\n  quantity=1\n)\naccount.charge(credit)"},{"language":"csharp","code":"var account = Accounts.Get(\"1\");\nvar adjustment = account.NewAdjustment(\n\t\"USD\",                               // currency\n\t-2000,                               // unit_amount_in_cents\n\t\"Bonus for being a great customer\", // description\n\t1);                                  // quantity (default is 1)\nadjustment.Create();"},{"language":"xml","code":"<adjustment>\n  <description>Bonus for being a great customer</description>\n  <unit_amount_in_cents>-2000</unit_amount_in_cents>\n  <currency>USD</currency>\n  <quantity>1</quantity>\n  <revenue_schedule_type>at_invoice</revenue_schedule_type>\n</adjustment>"}]},"params":[{"_id":"557f5188eb75d80d00af40a6","ref":"","in":"body","required":true,"desc":"Currency, 3-letter ISO code.","default":"","type":"string","name":"currency"},{"_id":"557f5188eb75d80d00af40a7","ref":"","in":"path","required":true,"desc":"Your unique account identifier.","default":"","type":"string","name":"account_code"},{"_id":"557f5188eb75d80d00af40a5","ref":"","in":"body","required":true,"desc":"Positive amount for a charge, negative amount for a credit. Max 10000000.","default":"","type":"string","name":"unit_amount_in_cents"},{"_id":"557f5188eb75d80d00af40a3","default":"1","desc":"Quantity.","in":"body","name":"quantity","ref":"","required":false,"type":"int"},{"_id":"557f5188eb75d80d00af40a4","ref":"","in":"body","required":false,"desc":"Description of the adjustment for the invoice.","default":"","type":"string","name":"description"},{"_id":"557f5188eb75d80d00af40a2","ref":"","in":"body","required":false,"desc":"Accounting code. Max of 20 characters.","default":"","type":"string","name":"accounting_code"},{"_id":"578f7836dbb58b0e00bbdf87","ref":"","in":"body","required":false,"desc":"Optional field for setting a revenue schedule type. This will determine how revenue for the associated Credit should be recognized. When creating a Credit, if you supply an `end_date` and `end_date` available schedule types are `never`, `evenly`, `at_invoice`, `at_range_start`, or `at_range_end`. If you do not supply an `end_date` available schedule types are `never`, `at_range_end`, and `at_invoice`.","default":"","type":"string","name":"revenue_schedule_type"},{"_id":"557f5188eb75d80d00af40a1","ref":"","in":"body","required":false,"desc":"`true` exempts tax on the charge, `false` applies tax on the charge. If not defined, then defaults to the Plan and Site settings. This attribute does not work for credits (negative adjustments). Credits are always post-tax. Pre-tax discounts should use the Coupons feature.","default":"","type":"boolean","name":"tax_exempt"},{"_id":"557f5188eb75d80d00af40a0","ref":"","in":"body","required":false,"desc":"Optional field for EU VAT merchants and Avalara AvaTax Pro merchants. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`. If you have your own AvaTax account configured, you can use Avalara tax codes to assign custom tax rules.","default":"","type":"string","name":"tax_code"},{"_id":"55e0dcbda44fae0d0021491f","ref":"","in":"body","required":false,"desc":"A timestamp associated with when the credit began.","default":"now","type":"timestamp","name":"start_date"},{"_id":"55e0dcbda44fae0d0021491e","ref":"","in":"body","required":false,"desc":"A timestamp associated with when the credit ended.","default":"","type":"timestamp","name":"end_date"}],"results":{"codes":[{"status":201,"language":"xml","code":"<adjustment href=\"https://your-subdomain.recurly.com/v2/adjustments/37c0038fe1ffc9405019db4a11a99aa8\" type=\"credit\">\n  <account href=\"https://your-subdomain.recurly.com/v2/accounts/1\"/>\n  <uuid>37c0038fe1ffc9405019db4a11a99aa8</uuid>\n  <state>pending</state>\n  <description>Bonus for being a great customer</description>\n  <accounting_code nil=\"nil\"/>\n  <product_code nil=\"nil\"/>\n  <origin>credit</origin>\n  <unit_amount_in_cents type=\"integer\">-2000</unit_amount_in_cents>\n  <quantity type=\"integer\">1</quantity>\n  <discount_in_cents type=\"integer\">0</discount_in_cents>\n  <tax_in_cents type=\"integer\">0</tax_in_cents>\n  <total_in_cents type=\"integer\">-2000</total_in_cents>\n  <currency>USD</currency>\n  <taxable type=\"boolean\">false</taxable>\n  <tax_exempt type=\"boolean\">false</tax_exempt>\n  <tax_code nil=\"nil\"/>\n  <start_date type=\"datetime\">2016-08-03T16:24:20Z</start_date>\n  <end_date nil=\"nil\"/>\n  <created_at type=\"datetime\">2016-08-03T16:24:20Z</created_at>\n  <updated_at type=\"datetime\">2016-08-03T16:24:20Z</updated_at>\n  <revenue_schedule_type>at_invoice</revenue_schedule_type>\n</adjustment>","name":""}]},"settings":"","url":"/accounts/:account_code/adjustments"},"body":"","category":"578e7c59b434c30e0035bf2b","createdAt":"2015-08-07T19:15:36.088Z","excerpt":"Creates a one-time charge on an account. Charges are not invoiced or collected immediately. Non-invoiced charges will automatically be invoices when the account's subscription renews, or you trigger a collection by posting an invoice. Charges may be removed from an account if they have not been invoiced.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"create-a-credit","sync_unique":"","title":"Create Credit","type":"post","updates":["563ce057913e650d00b65f47"],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

postCreate Credit

Creates a one-time charge on an account. Charges are not invoiced or collected immediately. Non-invoiced charges will automatically be invoices when the account's subscription renews, or you trigger a collection by posting an invoice. Charges may be removed from an account if they have not been invoiced.

currency:
required
string
Currency, 3-letter ISO code.
account_code:
required
string
Your unique account identifier.
unit_amount_in_cents:
required
string
Positive amount for a charge, negative amount for a credit. Max 10000000.
quantity:
integer1
Quantity.
description:
string
Description of the adjustment for the invoice.
accounting_code:
string
Accounting code. Max of 20 characters.
revenue_schedule_type:
string
Optional field for setting a revenue schedule type. This will determine how revenue for the associated Credit should be recognized. When creating a Credit, if you supply an `end_date` and `end_date` available schedule types are `never`, `evenly`, `at_invoice`, `at_range_start`, or `at_range_end`. If you do not supply an `end_date` available schedule types are `never`, `at_range_end`, and `at_invoice`.
tax_exempt:
boolean
`true` exempts tax on the charge, `false` applies tax on the charge. If not defined, then defaults to the Plan and Site settings. This attribute does not work for credits (negative adjustments). Credits are always post-tax. Pre-tax discounts should use the Coupons feature.
tax_code:
string
Optional field for EU VAT merchants and Avalara AvaTax Pro merchants. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`. If you have your own AvaTax account configured, you can use Avalara tax codes to assign custom tax rules.
start_date:
timestampnow
A timestamp associated with when the credit began.
end_date:
timestamp
A timestamp associated with when the credit ended.

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php

$credit = new Recurly_Adjustment();
$credit->account_code = '1';
$credit->description = 'Bonus for being a great customer';
$credit->unit_amount_in_cents = -2000; // Negative $20.00.
$credit->currency = 'USD';
$credit->quantity = 1;
$credit->create();
account = Recurly::Account.find('1')
account.adjustments.create(
  :description          => 'Bonus for being a great customer',
  :unit_amount_in_cents => -20_00,
  :currency             => 'USD',
  :quantity             => 1
)
account = Account.get('1')
credit = Adjustment(
  description='Bonus for being a great customer',
  unit_amount_in_cents=-2000,
  currency='USD',
  quantity=1
)
account.charge(credit)
var account = Accounts.Get("1");
var adjustment = account.NewAdjustment(
	"USD",                               // currency
	-2000,                               // unit_amount_in_cents
	"Bonus for being a great customer", // description
	1);                                  // quantity (default is 1)
adjustment.Create();
<adjustment>
  <description>Bonus for being a great customer</description>
  <unit_amount_in_cents>-2000</unit_amount_in_cents>
  <currency>USD</currency>
  <quantity>1</quantity>
  <revenue_schedule_type>at_invoice</revenue_schedule_type>
</adjustment>

Result Format

<adjustment href="https://your-subdomain.recurly.com/v2/adjustments/37c0038fe1ffc9405019db4a11a99aa8" type="credit">
  <account href="https://your-subdomain.recurly.com/v2/accounts/1"/>
  <uuid>37c0038fe1ffc9405019db4a11a99aa8</uuid>
  <state>pending</state>
  <description>Bonus for being a great customer</description>
  <accounting_code nil="nil"/>
  <product_code nil="nil"/>
  <origin>credit</origin>
  <unit_amount_in_cents type="integer">-2000</unit_amount_in_cents>
  <quantity type="integer">1</quantity>
  <discount_in_cents type="integer">0</discount_in_cents>
  <tax_in_cents type="integer">0</tax_in_cents>
  <total_in_cents type="integer">-2000</total_in_cents>
  <currency>USD</currency>
  <taxable type="boolean">false</taxable>
  <tax_exempt type="boolean">false</tax_exempt>
  <tax_code nil="nil"/>
  <start_date type="datetime">2016-08-03T16:24:20Z</start_date>
  <end_date nil="nil"/>
  <created_at type="datetime">2016-08-03T16:24:20Z</created_at>
  <updated_at type="datetime">2016-08-03T16:24:20Z</updated_at>
  <revenue_schedule_type>at_invoice</revenue_schedule_type>
</adjustment>


{"__v":0,"_id":"578e7c59b434c30e0035bf50","api":{"auth":"required","examples":{"codes":[{"name":"","code":"<?php\n\ntry {\n  $adjustment = Recurly_Adjustment::get('2fded6a3e36e8b56b37007432f8c1b0d');\n  print \"Adjustment: $adjustment\";\n} catch (Recurly_NotFoundError $e) {\n  print \"Invalid adjustment uuid: $e\";\n}","language":"php"},{"code":"adjustment = Recurly::Adjustment.find('30498bb2d52bb9037b4d62480eb98b8f')\n","language":"ruby"},{"code":"adjustment = Adjustment.get('30498bb2d52bb9037b4d62480eb98b8f')\n","language":"python"},{"code":"var adjustment = Adjustments.Get(\"30498bb2d52bb9037b4d62480eb98b8f\");\nConsole.WriteLine(\"Adjustment: \" + adjustment);","language":"csharp"}]},"params":[{"_id":"55944f4fccc3052300569883","ref":"","in":"path","required":true,"desc":"The unique identifier for the adjustment","default":"","type":"string","name":"uuid"}],"results":{"codes":[{"name":"","code":"<adjustment href=\"https://your-subdomain.recurly.com/v2/adjustments/37c0057d2bc64f2dd6a1c944dc87fbb5\" type=\"charge\">\n  <account href=\"https://your-subdomain.recurly.com/v2/accounts/1\"/>\n  <invoice href=\"https://your-subdomain.recurly.com/v2/invoices/1007\"/>\n  <subscription href=\"https://your-subdomain.recurly.com/v2/subscriptions/37c0057cb105f67b6b8a1146f7b59c41\"/>\n  <uuid>37c0057d2bc64f2dd6a1c944dc87fbb5</uuid>\n  <state>invoiced</state>\n  <description>Gold plan</description>\n  <accounting_code nil=\"nil\"/>\n  <product_code>gold</product_code>\n  <origin>plan</origin>\n  <unit_amount_in_cents type=\"integer\">4500</unit_amount_in_cents>\n  <quantity type=\"integer\">1</quantity>\n  <discount_in_cents type=\"integer\">450</discount_in_cents>\n  <tax_in_cents type=\"integer\">354</tax_in_cents>\n  <total_in_cents type=\"integer\">4404</total_in_cents>\n  <currency>EUR</currency>\n  <taxable type=\"boolean\">false</taxable>\n  <tax_type>usst</tax_type>\n  <tax_region>CA</tax_region>\n  <tax_rate type=\"float\">0.0875</tax_rate>\n  <tax_exempt type=\"boolean\">false</tax_exempt>\n  <tax_code nil=\"nil\"/>\n  <tax_details type=\"array\">\n    <tax_detail>\n      <name nil=\"nil\"/>\n      <type>state</type>\n      <tax_rate type=\"float\">0.065</tax_rate>\n      <tax_in_cents type=\"integer\">263</tax_in_cents>\n    </tax_detail>\n    <tax_detail>\n      <name nil=\"nil\"/>\n      <type>county</type>\n      <tax_rate type=\"float\">0.01</tax_rate>\n      <tax_in_cents type=\"integer\">41</tax_in_cents>\n    </tax_detail>\n    <tax_detail>\n      <name nil=\"nil\"/>\n      <type>city</type>\n      <tax_rate type=\"float\">0.0</tax_rate>\n      <tax_in_cents type=\"integer\">0</tax_in_cents>\n    </tax_detail>\n    <tax_detail>\n      <name nil=\"nil\"/>\n      <type>special</type>\n      <tax_rate type=\"float\">0.0125</tax_rate>\n      <tax_in_cents type=\"integer\">51</tax_in_cents>\n    </tax_detail>\n  </tax_details>\n  <start_date type=\"datetime\">2016-08-03T16:26:26Z</start_date>\n  <end_date type=\"datetime\">2016-09-03T16:26:26Z</end_date>\n  <created_at type=\"datetime\">2016-08-03T16:26:26Z</created_at>\n  <updated_at type=\"datetime\">2016-08-03T16:26:26Z</updated_at>\n  <revenue_schedule_type>evenly</revenue_schedule_type>\n</adjustment>","language":"xml","status":200}]},"settings":"","url":"/adjustments/:uuid"},"body":"","category":"578e7c59b434c30e0035bf2b","createdAt":"2015-06-15T22:24:48.657Z","excerpt":"Returns information about a single adjustment.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"get-an-adjustment","sync_unique":"","title":"Lookup Adjustment","type":"get","updates":["55b79c68aea7c8190058b98e"],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

getLookup Adjustment

Returns information about a single adjustment.

uuid:
required
string
The unique identifier for the adjustment

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php

try {
  $adjustment = Recurly_Adjustment::get('2fded6a3e36e8b56b37007432f8c1b0d');
  print "Adjustment: $adjustment";
} catch (Recurly_NotFoundError $e) {
  print "Invalid adjustment uuid: $e";
}
adjustment = Recurly::Adjustment.find('30498bb2d52bb9037b4d62480eb98b8f')
adjustment = Adjustment.get('30498bb2d52bb9037b4d62480eb98b8f')
var adjustment = Adjustments.Get("30498bb2d52bb9037b4d62480eb98b8f");
Console.WriteLine("Adjustment: " + adjustment);

Result Format

<adjustment href="https://your-subdomain.recurly.com/v2/adjustments/37c0057d2bc64f2dd6a1c944dc87fbb5" type="charge">
  <account href="https://your-subdomain.recurly.com/v2/accounts/1"/>
  <invoice href="https://your-subdomain.recurly.com/v2/invoices/1007"/>
  <subscription href="https://your-subdomain.recurly.com/v2/subscriptions/37c0057cb105f67b6b8a1146f7b59c41"/>
  <uuid>37c0057d2bc64f2dd6a1c944dc87fbb5</uuid>
  <state>invoiced</state>
  <description>Gold plan</description>
  <accounting_code nil="nil"/>
  <product_code>gold</product_code>
  <origin>plan</origin>
  <unit_amount_in_cents type="integer">4500</unit_amount_in_cents>
  <quantity type="integer">1</quantity>
  <discount_in_cents type="integer">450</discount_in_cents>
  <tax_in_cents type="integer">354</tax_in_cents>
  <total_in_cents type="integer">4404</total_in_cents>
  <currency>EUR</currency>
  <taxable type="boolean">false</taxable>
  <tax_type>usst</tax_type>
  <tax_region>CA</tax_region>
  <tax_rate type="float">0.0875</tax_rate>
  <tax_exempt type="boolean">false</tax_exempt>
  <tax_code nil="nil"/>
  <tax_details type="array">
    <tax_detail>
      <name nil="nil"/>
      <type>state</type>
      <tax_rate type="float">0.065</tax_rate>
      <tax_in_cents type="integer">263</tax_in_cents>
    </tax_detail>
    <tax_detail>
      <name nil="nil"/>
      <type>county</type>
      <tax_rate type="float">0.01</tax_rate>
      <tax_in_cents type="integer">41</tax_in_cents>
    </tax_detail>
    <tax_detail>
      <name nil="nil"/>
      <type>city</type>
      <tax_rate type="float">0.0</tax_rate>
      <tax_in_cents type="integer">0</tax_in_cents>
    </tax_detail>
    <tax_detail>
      <name nil="nil"/>
      <type>special</type>
      <tax_rate type="float">0.0125</tax_rate>
      <tax_in_cents type="integer">51</tax_in_cents>
    </tax_detail>
  </tax_details>
  <start_date type="datetime">2016-08-03T16:26:26Z</start_date>
  <end_date type="datetime">2016-09-03T16:26:26Z</end_date>
  <created_at type="datetime">2016-08-03T16:26:26Z</created_at>
  <updated_at type="datetime">2016-08-03T16:26:26Z</updated_at>
  <revenue_schedule_type>evenly</revenue_schedule_type>
</adjustment>


{"__v":0,"_id":"578e7c59b434c30e0035bf53","api":{"examples":{"codes":[{"name":"","code":"<?php\n\ntry {\n  $adjustment = Recurly_Adjustment::get('626db120a84102b1809909071c701c60');\n  $adjustment->delete();\n\n  print \"Adjustment: $adjustment\";\n} catch (Recurly_NotFoundError $e) {\n  // NotFoundError if invalid uuid or already deleted\n  print \"Invalid adjustment uuid: $e\";\n}\n","language":"php"},{"code":"adjustment = Recurly::Adjustment.find('945a4cb9afd64300b97b138407a51aef')\nadjustment.destroy","language":"ruby"},{"code":"adjustment = Adjustment.get('945a4cb9afd64300b97b138407a51aef')\nadjustment.delete()","language":"python"},{"code":"var adjustment = Adjustments.Get(\"945a4cb9afd64300b97b138407a51aef\");\nadjustment.Delete(","language":"csharp"}]},"results":{"codes":[{"code":"Status: 204 No Content","language":"xml","status":204}]},"settings":"","auth":"required","params":[{"_id":"55944f6a0c33bd0d0005964a","ref":"","in":"path","required":true,"desc":"The unique identifier for the adjustment","default":"","type":"string","name":"uuid"}],"url":"/adjustments/:uuid"},"body":"[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Please note\",\n  \"body\": \"An adjustment may only be deleted if it has not been invoiced.\"\n}\n[/block]","category":"578e7c59b434c30e0035bf2b","createdAt":"2015-06-15T23:21:38.993Z","excerpt":"Delete an adjustment from an account. Only non-invoiced adjustments can be deleted.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"delete-an-adjustment","sync_unique":"","title":"Delete Adjustment","type":"delete","updates":[],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

deleteDelete Adjustment

Delete an adjustment from an account. Only non-invoiced adjustments can be deleted.

uuid:
required
string
The unique identifier for the adjustment

Please note

An adjustment may only be deleted if it has not been invoiced.

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php

try {
  $adjustment = Recurly_Adjustment::get('626db120a84102b1809909071c701c60');
  $adjustment->delete();

  print "Adjustment: $adjustment";
} catch (Recurly_NotFoundError $e) {
  // NotFoundError if invalid uuid or already deleted
  print "Invalid adjustment uuid: $e";
}
adjustment = Recurly::Adjustment.find('945a4cb9afd64300b97b138407a51aef')
adjustment.destroy
adjustment = Adjustment.get('945a4cb9afd64300b97b138407a51aef')
adjustment.delete()
var adjustment = Adjustments.Get("945a4cb9afd64300b97b138407a51aef");
adjustment.Delete(

Result Format

Status: 204 No Content


{"__v":0,"_id":"578e7c5ab434c30e0035bf73","api":{"examples":{"codes":[{"name":"","code":"<?php\n\ntry {\n  $billing_info = new Recurly_BillingInfo();\n  $billing_info->account_code = 'b6f5783';\n  $billing_info->token_id = '7z6furn4jvb9'; // From Recurly.js\n  $billing_info->create();\n\n  print \"Billing Info: $billing_info\";\n} catch (Recurly_NotFoundError $e) {\n  // Could not find account or token is invalid or expired\n  print \"Not Found: $e\";\n}","language":"php"},{"code":"account = Recurly::Account.find('1')\naccount.billing_info = {\n  token_id: 'TOKEN_ID'\n}\naccount.billing_info.save!","language":"ruby"},{"code":"account = Account.get('1')\nbilling_info = account.billing_info\nbilling_info.token_id = 'TOKEN_ID'\naccount.update_billing_info(billing_info)","language":"python"},{"code":"var account = Accounts.Get(\"1\");\nvar info = new BillingInfo(account);\ninfo.TokenId = \"TOKEN_ID\";\ninfo.Create();","language":"csharp"},{"code":"<billing_info>\n  <token_id>TOKEN_ID</token_id>\n</billing_info>","language":"xml"}]},"results":{"codes":[{"name":"","code":"<billing_info href=\"https://your-subdomain.recurly.com/v2/accounts/1/billing_info\" type=\"credit_card\">\n  <account href=\"https://your-subdomain.recurly.com/v2/accounts/1\"/>\n  <first_name>Verena</first_name>\n  <last_name>Example</last_name>\n  <company nil=\"nil\"></company>\n  <address1>123 Main St.</address1>\n  <address2 nil=\"nil\"></address2>\n  <city>San Francisco</city>\n  <state>CA</state>\n  <zip>94105</zip>\n  <country>US</country>\n  <phone nil=\"nil\"></phone>\n  <vat_number>US1234567890</vat_number>\n  <ip_address>127.0.0.1</ip_address>\n  <ip_address_country>US</ip_address_country>\n  <card_type>Visa</card_type>\n  <year type=\"integer\">2019</year>\n  <month type=\"integer\">11</month>\n  <first_six>411111</first_six>\n  <last_four>1111</last_four>\n</billing_info>","language":"xml","status":201}]},"settings":"","auth":"required","params":[{"_id":"55944f99ccc3052300569885","ref":"","in":"path","required":true,"desc":"Account's unique code.","default":"","type":"string","name":"account_code"},{"_id":"5581ced4a5474a0d00d946a5","ref":"","in":"body","required":true,"desc":"A token [generated by Recurly.js](https://docs.recurly.com/js/#getting-a-token)","default":"","type":"string","name":"token_id"},{"_id":"56d0e86f40d36e1d00bc14c9","ref":"","in":"body","required":false,"desc":"Currency in which invoices will be posted. Only applicable if this account is enrolled in a plan has a different currency than your site's default.","default":"","type":"string","name":"currency"}],"url":"/accounts/:account_code/billing_info"},"body":"","category":"578e7c59b434c30e0035bf2c","createdAt":"2015-06-17T19:47:32.787Z","excerpt":"Creates an account's Billing Information using a [token generated by Recurly.js](https://docs.recurly.com/js/#getting-a-token). Returns the account's created Billing Information.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"create-an-accounts-billing-info-token","sync_unique":"","title":"Create Account's Billing Info (Token)","type":"post","updates":["56799b95239fac0d00c7e019"],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

postCreate Account's Billing Info (Token)

Creates an account's Billing Information using a [token generated by Recurly.js](https://docs.recurly.com/js/#getting-a-token). Returns the account's created Billing Information.

account_code:
required
string
Account's unique code.
token_id:
required
string
A token [generated by Recurly.js](https://docs.recurly.com/js/#getting-a-token)
currency:
string
Currency in which invoices will be posted. Only applicable if this account is enrolled in a plan has a different currency than your site's default.

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php

try {
  $billing_info = new Recurly_BillingInfo();
  $billing_info->account_code = 'b6f5783';
  $billing_info->token_id = '7z6furn4jvb9'; // From Recurly.js
  $billing_info->create();

  print "Billing Info: $billing_info";
} catch (Recurly_NotFoundError $e) {
  // Could not find account or token is invalid or expired
  print "Not Found: $e";
}
account = Recurly::Account.find('1')
account.billing_info = {
  token_id: 'TOKEN_ID'
}
account.billing_info.save!
account = Account.get('1')
billing_info = account.billing_info
billing_info.token_id = 'TOKEN_ID'
account.update_billing_info(billing_info)
var account = Accounts.Get("1");
var info = new BillingInfo(account);
info.TokenId = "TOKEN_ID";
info.Create();
<billing_info>
  <token_id>TOKEN_ID</token_id>
</billing_info>

Result Format

<billing_info href="https://your-subdomain.recurly.com/v2/accounts/1/billing_info" type="credit_card">
  <account href="https://your-subdomain.recurly.com/v2/accounts/1"/>
  <first_name>Verena</first_name>
  <last_name>Example</last_name>
  <company nil="nil"></company>
  <address1>123 Main St.</address1>
  <address2 nil="nil"></address2>
  <city>San Francisco</city>
  <state>CA</state>
  <zip>94105</zip>
  <country>US</country>
  <phone nil="nil"></phone>
  <vat_number>US1234567890</vat_number>
  <ip_address>127.0.0.1</ip_address>
  <ip_address_country>US</ip_address_country>
  <card_type>Visa</card_type>
  <year type="integer">2019</year>
  <month type="integer">11</month>
  <first_six>411111</first_six>
  <last_four>1111</last_four>
</billing_info>


{"__v":0,"_id":"578e7c5ab434c30e0035bf74","api":{"auth":"required","examples":{"codes":[{"name":"","code":"<?php\n\ntry {\n  $billing_info = new Recurly_BillingInfo();\n  $billing_info->account_code = 'b6f5783';\n  $billing_info->first_name = 'Verena';\n  $billing_info->last_name = 'Example';\n  $billing_info->number = '4111-1111-1111-1111';\n  $billing_info->verification_value = '123';\n  $billing_info->month = 11;\n  $billing_info->year = 2019;\n  $billing_info->create();\n\n  print \"Billing Info: $billing_info\";\n} catch (Recurly_ValidationError $e) {\n  // The data or card are invalid\n  print \"Invalid data or card: $e\";\n} catch (Recurly_NotFoundError $e) {\n  // Could not find account\n  print \"Not Found: $e\";\n}","language":"php"},{"code":"account = Recurly::Account.find('1')\naccount.billing_info = {\n  :first_name         => 'Verena',\n  :last_name          => 'Example',\n  :number             => '4111-1111-1111-1111',\n  :verification_value => '123',\n  :month              => 11,\n  :year               => 2019\n}\naccount.billing_info.save!","language":"ruby"},{"code":"account = Account.get('1')\nbilling_info = account.billing_info\nbilling_info.first_name = 'Verena'\nbilling_info.last_name = 'Example'\nbilling_info.number = '4111-1111-1111-1111'\nbilling_info.verification_value = '123'\nbilling_info.month = 11\nbilling_info.year = 2019\naccount.update_billing_info(billing_info)","language":"python"},{"code":"var account = Accounts.Get(\"1\");\nvar info = new BillingInfo(account);\ninfo.FirstName = \"Verana\";\ninfo.LastName = \"Example\";\ninfo.CreditCardNumber = \"4111-1111-1111-1111\";\ninfo.VerificationValue = \"123\";\ninfo.ExpirationMonth = 11;\ninfo.ExpirationYear = 2019;\ninfo.Create();","language":"csharp"},{"code":"<billing_info>\n  <first_name>Verena</first_name>\n  <last_name>Example</last_name>\n  <address1>123 Main St.</address1>\n  <address2 nil=\"nil\"></address2>\n  <city>San Francisco</city>\n  <state>CA</state>\n  <zip>94105</zip>\n  <country>US</country>\n  <number>4111-1111-1111-1111</number>\n  <verification_value>123</verification_value>\n  <month>11</month>\n  <year>2019</year>\n  <ip_address>127.0.0.1</ip_address>\n</billing_info>","language":"xml"}]},"params":[{"_id":"55944fab5c9eaa2300a8633c","ref":"","in":"path","required":true,"desc":"Account's unique code.","default":"","type":"string","name":"account_code"},{"_id":"5581d09a8625220d00429e4d","ref":"","in":"body","required":true,"desc":"First name","default":"","type":"string","name":"first_name"},{"_id":"5581d09a8625220d00429e4c","ref":"","in":"body","required":true,"desc":"Last name","default":"","type":"string","name":"last_name"},{"_id":"5581d09a8625220d00429e42","ref":"","in":"body","required":true,"desc":"Credit card number, spaces and dashes are accepted","default":"","type":"string","name":"number"},{"_id":"5581d09a8625220d00429e41","ref":"","in":"body","required":true,"desc":"Expiration month","default":"","type":"string","name":"month"},{"_id":"5581d09a8625220d00429e40","ref":"","in":"body","required":true,"desc":"Expiration year","default":"","type":"string","name":"year"},{"_id":"5581d09a8625220d00429e4b","ref":"","in":"body","required":false,"desc":"Address line 1, recommended for address validation","default":"","type":"string","name":"address1"},{"_id":"5581d09a8625220d00429e4a","ref":"","in":"body","required":false,"desc":"Address line 2.","default":"","type":"string","name":"address2"},{"_id":"5581d09a8625220d00429e49","ref":"","in":"body","required":false,"desc":"City","default":"","type":"string","name":"city"},{"_id":"5581d09a8625220d00429e48","ref":"","in":"body","required":false,"desc":"State","default":"","type":"string","name":"state"},{"_id":"5581d09a8625220d00429e47","ref":"","in":"body","required":false,"desc":"Country, [2-letter ISO code](http://www.iso.org/iso/country_names_and_code_elements) **STRONGLY RECOMMENDED**","default":"","type":"string","name":"country"},{"_id":"5581d09a8625220d00429e46","ref":"","in":"body","required":false,"desc":"Zip or postal code, recommended for address validation","default":"","type":"string","name":"zip"},{"_id":"5581d09a8625220d00429e45","ref":"","in":"body","required":false,"desc":"Phone number","default":"","type":"string","name":"phone"},{"_id":"5581d09a8625220d00429e44","ref":"","in":"body","required":false,"desc":"Customer's VAT Number","default":"","type":"string","name":"vat_number"},{"_id":"56c3c1ce70187b17005f4395","ref":"","in":"body","required":false,"desc":"Currency in which invoices will be posted. Only applicable if this account is enrolled in a plan has a different currency than your site's default.","default":"","type":"string","name":"currency"},{"_id":"5581d09a8625220d00429e3f","ref":"","in":"body","required":false,"desc":"Security code or CVV, 3-4 digits **STRONGLY RECOMMENDED**","default":"","type":"string","name":"verification_value"},{"_id":"5581d09a8625220d00429e43","ref":"","in":"body","required":false,"desc":"Customer's IP address when updating their Billing Information **STRONGLY RECOMMENDED**","default":"","type":"string","name":"ip_address"}],"results":{"codes":[{"name":"","code":"<billing_info href=\"https://your-subdomain.recurly.com/v2/accounts/1/billing_info\" type=\"credit_card\">\n  <account href=\"https://your-subdomain.recurly.com/v2/accounts/1\"/>\n  <first_name>Verena</first_name>\n  <last_name>Example</last_name>\n  <company nil=\"nil\"/>\n  <address1>123 Main St.</address1>\n  <address2 nil=\"nil\"/>\n  <city>San Francisco</city>\n  <state>CA</state>\n  <zip>94105</zip>\n  <country>US</country>\n  <phone nil=\"nil\"/>\n  <vat_number nil=\"nil\"/>\n  <ip_address>127.0.0.1</ip_address>\n  <ip_address_country nil=\"nil\"/>\n  <card_type>Visa</card_type>\n  <year type=\"integer\">2019</year>\n  <month type=\"integer\">11</month>\n  <first_six>411111</first_six>\n  <last_four>1111</last_four>\n</billing_info>","language":"xml","status":201}]},"settings":"","url":"/accounts/:account_code/billing_info"},"body":"Instead of using a token generated by Recurly.js, you can instead submit full credit card and address information when creating Billing Information.\n\nWhen Billing Information is submitted, it is only saved if valid. If the account has a past due invoice, the outstanding balance will be collected to validate the Billing Information.\n\nIf you want to create an account at the same time, you should use the [Account API end-point](https://docs.recurly.com/api/accounts#create-account) instead and include Billing Information with your request.\n\nThe required address fields will correspond to the **address requirements** configured for your site.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Recurly strongly recommends using a token [generated by Recurly.js](https://docs.recurly.com/js/#getting-a-token) rather than directly handling your customer's credit card details.\",\n  \"title\": \"Please note\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"This API end-point may be used to import Billing Information without security codes (CVV). Recurly recommends requiring CVV from your customers when collecting new or updated Billing Information.\",\n  \"title\": \"Please note\"\n}\n[/block]","category":"578e7c59b434c30e0035bf2c","createdAt":"2015-06-17T19:55:06.712Z","excerpt":"Creates the account's Billing Information.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"create-an-accounts-billing-info-credit-card","sync_unique":"","title":"Create Account's Billing Info (Credit Card)","type":"post","updates":["55d336260168850d0073f054","562944f61a92870d0002c301","56bb59bae59a312b00a15bac"],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

postCreate Account's Billing Info (Credit Card)

Creates the account's Billing Information.

account_code:
required
string
Account's unique code.
first_name:
required
string
First name
last_name:
required
string
Last name
number:
required
string
Credit card number, spaces and dashes are accepted
month:
required
string
Expiration month
year:
required
string
Expiration year
address1:
string
Address line 1, recommended for address validation
address2:
string
Address line 2.
city:
string
City
state:
string
State
country:
string
Country, [2-letter ISO code](http://www.iso.org/iso/country_names_and_code_elements) **STRONGLY RECOMMENDED**
zip:
string
Zip or postal code, recommended for address validation
phone:
string
Phone number
vat_number:
string
Customer's VAT Number
currency:
string
Currency in which invoices will be posted. Only applicable if this account is enrolled in a plan has a different currency than your site's default.
verification_value:
string
Security code or CVV, 3-4 digits **STRONGLY RECOMMENDED**
ip_address:
string
Customer's IP address when updating their Billing Information **STRONGLY RECOMMENDED**

Instead of using a token generated by Recurly.js, you can instead submit full credit card and address information when creating Billing Information.

When Billing Information is submitted, it is only saved if valid. If the account has a past due invoice, the outstanding balance will be collected to validate the Billing Information.

If you want to create an account at the same time, you should use the Account API end-point instead and include Billing Information with your request.

The required address fields will correspond to the address requirements configured for your site.

Please note

Recurly strongly recommends using a token generated by Recurly.js rather than directly handling your customer's credit card details.

Please note

This API end-point may be used to import Billing Information without security codes (CVV). Recurly recommends requiring CVV from your customers when collecting new or updated Billing Information.

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php

try {
  $billing_info = new Recurly_BillingInfo();
  $billing_info->account_code = 'b6f5783';
  $billing_info->first_name = 'Verena';
  $billing_info->last_name = 'Example';
  $billing_info->number = '4111-1111-1111-1111';
  $billing_info->verification_value = '123';
  $billing_info->month = 11;
  $billing_info->year = 2019;
  $billing_info->create();

  print "Billing Info: $billing_info";
} catch (Recurly_ValidationError $e) {
  // The data or card are invalid
  print "Invalid data or card: $e";
} catch (Recurly_NotFoundError $e) {
  // Could not find account
  print "Not Found: $e";
}
account = Recurly::Account.find('1')
account.billing_info = {
  :first_name         => 'Verena',
  :last_name          => 'Example',
  :number             => '4111-1111-1111-1111',
  :verification_value => '123',
  :month              => 11,
  :year               => 2019
}
account.billing_info.save!
account = Account.get('1')
billing_info = account.billing_info
billing_info.first_name = 'Verena'
billing_info.last_name = 'Example'
billing_info.number = '4111-1111-1111-1111'
billing_info.verification_value = '123'
billing_info.month = 11
billing_info.year = 2019
account.update_billing_info(billing_info)
var account = Accounts.Get("1");
var info = new BillingInfo(account);
info.FirstName = "Verana";
info.LastName = "Example";
info.CreditCardNumber = "4111-1111-1111-1111";
info.VerificationValue = "123";
info.ExpirationMonth = 11;
info.ExpirationYear = 2019;
info.Create();
<billing_info>
  <first_name>Verena</first_name>
  <last_name>Example</last_name>
  <address1>123 Main St.</address1>
  <address2 nil="nil"></address2>
  <city>San Francisco</city>
  <state>CA</state>
  <zip>94105</zip>
  <country>US</country>
  <number>4111-1111-1111-1111</number>
  <verification_value>123</verification_value>
  <month>11</month>
  <year>2019</year>
  <ip_address>127.0.0.1</ip_address>
</billing_info>

Result Format

<billing_info href="https://your-subdomain.recurly.com/v2/accounts/1/billing_info" type="credit_card">
  <account href="https://your-subdomain.recurly.com/v2/accounts/1"/>
  <first_name>Verena</first_name>
  <last_name>Example</last_name>
  <company nil="nil"/>
  <address1>123 Main St.</address1>
  <address2 nil="nil"/>
  <city>San Francisco</city>
  <state>CA</state>
  <zip>94105</zip>
  <country>US</country>
  <phone nil="nil"/>
  <vat_number nil="nil"/>
  <ip_address>127.0.0.1</ip_address>
  <ip_address_country nil="nil"/>
  <card_type>Visa</card_type>
  <year type="integer">2019</year>
  <month type="integer">11</month>
  <first_six>411111</first_six>
  <last_four>1111</last_four>
</billing_info>


{"__v":0,"_id":"578e7c5ab434c30e0035bf75","api":{"examples":{"codes":[{"language":"php","code":"<?php\n\ntry {\n  $billing_info = new Recurly_BillingInfo();\n  $billing_info->account_code = 'b6f5783';\n  $billing_info->name_on_account = 'Acme Inc.';\n  $billing_info->routing_number = '065400137';\n  $billing_info->account_number = '4444000000005555';\n  $billing_info->account_type = 'checking';\n  $billing_info->address1 = '123 Main St.';\n  $billing_info->city = 'San Francisco';\n  $billing_info->state ='CA';\n  $billing_info->country = 'US';\n  $billing_info->zip = '94105';\n  $billing_info->create();\n\n  print \"Billing Info: $billing_info\";\n} catch (Recurly_ValidationError $e) {\n  // The data or bank account are invalid\n  print \"Invalid data or card: $e\";\n} catch (Recurly_NotFoundError $e) {\n  // Could not find account\n  print \"Account Not Found: $e\";\n}","name":""},{"language":"ruby","code":"account = Recurly::Account.find('1')\naccount.billing_info = {\n  name_on_account: 'Acme, Inc.',\n  routing_number: '065400137',\n  account_number: '4444000000005555',\n  address1: '123 Main St.',\n  city: 'San Francisco',\n  state: 'CA',\n  country: 'US',\n  zip: '94105'\n}\naccount.billing_info.save!"},{"language":"python","code":"account = Account.get('1')\nbilling_info = recurly.BillingInfo(\n  name_on_account = 'Acme, Inc.',\n  routing_number = '065400137',\n  account_number = '4444000000005555',\n  account_type = 'checking',\n  address1 = '123 Main St.',\n  city = 'San Francisco',\n  state ='CA',\n  country = 'US',\n  zip = '94105'\n  )\naccount.update_billing_info(billing_info)"},{"language":"csharp","code":"var account = Accounts.Get(\"1\");\nvar info = new BillingInfo(account);\ninfo.NameOnAccount = \"Acme, Inc.\";\ninfo.RoutingNumber = \"065400137\";\ninfo.AccountNumber = \"4444000000005555\";\ninfo.AccountType = BillingInfo.BankAccountType.Checking;\ninfo.Address1 = \"123 Main St.\";\ninfo.City = \"San Francisco\";\ninfo.State = \"CA\";\ninfo.Country = \"US\";\ninfo.PostalCode = \"94105\";\ninfo.Create();"},{"language":"xml","code":"<billing_info>\n  <name_on_account>Acme, Inc.</name_on_account>\n  <address1>123 Main St.</address1>\n  <address2 nil=\"nil\"></address2>\n  <city>San Francisco</city>\n  <state>CA</state>\n  <zip>94105</zip>\n  <country>US</country>\n  <routing_number>065400137</routing_number>\n  <account_number>4444000000005555</account_number>\n  <account_type>checking</account_type>\n  <ip_address>127.0.0.1</ip_address>\n</billing_info>"}]},"results":{"codes":[{"status":201,"language":"xml","code":"<billing_info href=\"https://your-subdomain.recurly.com/v2/accounts/1/billing_info\" type=\"bank_account\">\n  <account href=\"https://your-subdomain.recurly.com/v2/accounts/1\"/>\n  <name_on_account>Acme, Inc.</name_on_account>\n  <first_name nil=\"nil\"></first_name>\n  <last_name nil=\"nil\"></last_name>\n  <company nil=\"nil\"></company>\n  <address1>123 Main St.</address1>\n  <address2 nil=\"nil\"></address2>\n  <city>San Francisco</city>\n  <state>CA</state>\n  <zip>94105</zip>\n  <country>US</country>\n  <phone></phone>\n  <vat_number></vat_number>\n  <ip_address>127.0.0.1</ip_address>\n  <ip_address_country>US</ip_address_country>\n  <account_type>checking</account_type>\n  <last_four>5555</last_four>\n  <routing_number>065400137</routing_number>\n</billing_info>","name":""}]},"settings":"","auth":"required","params":[{"_id":"55944fbb0c33bd0d0005964b","ref":"","in":"path","required":true,"desc":"Account's unique code.","default":"","type":"string","name":"account_code"},{"_id":"5581d1f08625220d00429e6d","ref":"","in":"body","required":true,"desc":"The name associated with the account. This may be a person's full name or a business name. This field must be 1 to 50 characters and can include: letters digits space . ' & , -","default":"","type":"string","name":"name_on_account"},{"_id":"5581d1f08625220d00429e63","ref":"","in":"body","required":true,"desc":"Must be a real U.S. bank account routing number. All routing numbers are 9 digits.","default":"","type":"int","name":"routing_number"},{"_id":"5581d1f08625220d00429e62","ref":"","in":"body","required":true,"desc":"Bank account number between 4 and 17 digits. We do not validate this number until the first transaction, so we recommend you have the customer confirm their account number.","default":"","type":"int","name":"account_number"},{"_id":"5581d1f08625220d00429e61","ref":"","in":"body","required":true,"desc":"Either 'checking' or 'savings'","default":"","type":"string","name":"account_type"},{"_id":"5581d1f08625220d00429e6c","ref":"","in":"body","required":false,"desc":"Address line 1, recommended for address validation. This field has a 50 character max and can include: letters digits space . # / , -","default":"","type":"string","name":"address1"},{"_id":"5581d1f08625220d00429e6b","ref":"","in":"body","required":false,"desc":"Address line 2, this field has a 50 character max and can include: letters digits space . # / , -","default":"","type":"string","name":"address2"},{"_id":"5581d1f08625220d00429e6a","ref":"","in":"body","required":false,"desc":"City, this field has a 50 character max and can include: letters digits space . , -","default":"","type":"string","name":"city"},{"_id":"5581d1f08625220d00429e69","ref":"","in":"body","required":false,"desc":"State, this field has a 2 character max and can be lowercase or uppercase.","default":"","type":"string","name":"state"},{"_id":"5581d1f08625220d00429e68","ref":"","in":"body","required":false,"desc":"Country, [2-letter ISO code](http://www.iso.org/iso/country_names_and_code_elements). **STRONGLY RECOMMENDED**","default":"","type":"string","name":"country"},{"_id":"5581d1f08625220d00429e67","ref":"","in":"body","required":false,"desc":"Zip or postal code, recommended for address validation. This field can be just 5 digits or can have an optional additional 4 digits separated by a hyphen (e.g. 12345-6789).","default":"","type":"string","name":"zip"},{"_id":"5581d1f08625220d00429e66","ref":"","in":"body","required":false,"desc":"Phone number, this field can be 10 digits.","default":"","type":"string","name":"phone"},{"_id":"5581d1f08625220d00429e65","ref":"","in":"body","required":false,"desc":"Customer's VAT Number","default":"","type":"string","name":"vat_number"},{"_id":"5581d1f08625220d00429e64","ref":"","in":"body","required":false,"desc":"Customer's IP address when updating their Billing Information **STRONGLY RECOMMENDED**","default":"","type":"string","name":"ip_address"}],"url":"/accounts/:account_code/billing_info"},"body":"Instead of using a token generated by Recurly.js, you can instead submit full bank account and address information when creating Billing Information.\n\nWhen Billing Information is submitted, it is only saved if the required fields are provided and they meet the field validation requirements. If the account has a past due invoice, the outstanding balance will be collected when the Billing Information is updated.\n\nIf you want to create an account at the same time, you should use the [Account API end-point](https://docs.recurly.com/api/accounts#create-account) instead and include Billing Information with your request.\n\nThe required address fields will correspond to the **address requirements** configured for your site.\nIf you need to set a back dated subscription authorziation date for the NACHA three year re-authorization rule, do so on the Create Subscription call using the \"bank_account_authorized_at\" attribute.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Please note\",\n  \"body\": \"Recurly strongly recommends using a token [generated by Recurly.js](https://docs.recurly.com/js/#getting-a-token) rather than directly handling your customer's bank account details.\"\n}\n[/block]","category":"578e7c59b434c30e0035bf2c","createdAt":"2015-06-17T20:00:48.689Z","excerpt":"Creates the account's Billing Information with Bank Account details. You will need to have the ACH feature on your site for this call to work.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"create-an-accounts-billing-info-bank-account","sync_unique":"","title":"Create Account's Billing Info (Bank Account)","type":"post","updates":["56ec2580df213e1700f77836"],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

postCreate Account's Billing Info (Bank Account)

Creates the account's Billing Information with Bank Account details. You will need to have the ACH feature on your site for this call to work.

account_code:
required
string
Account's unique code.
name_on_account:
required
string
The name associated with the account. This may be a person's full name or a business name. This field must be 1 to 50 characters and can include: letters digits space . ' & , -
routing_number:
required
integer
Must be a real U.S. bank account routing number. All routing numbers are 9 digits.
account_number:
required
integer
Bank account number between 4 and 17 digits. We do not validate this number until the first transaction, so we recommend you have the customer confirm their account number.
account_type:
required
string
Either 'checking' or 'savings'
address1:
string
Address line 1, recommended for address validation. This field has a 50 character max and can include: letters digits space . # / , -
address2:
string
Address line 2, this field has a 50 character max and can include: letters digits space . # / , -
city:
string
City, this field has a 50 character max and can include: letters digits space . , -
state:
string
State, this field has a 2 character max and can be lowercase or uppercase.
country:
string
Country, [2-letter ISO code](http://www.iso.org/iso/country_names_and_code_elements). **STRONGLY RECOMMENDED**
zip:
string
Zip or postal code, recommended for address validation. This field can be just 5 digits or can have an optional additional 4 digits separated by a hyphen (e.g. 12345-6789).
phone:
string
Phone number, this field can be 10 digits.
vat_number:
string
Customer's VAT Number
ip_address:
string
Customer's IP address when updating their Billing Information **STRONGLY RECOMMENDED**

Instead of using a token generated by Recurly.js, you can instead submit full bank account and address information when creating Billing Information.

When Billing Information is submitted, it is only saved if the required fields are provided and they meet the field validation requirements. If the account has a past due invoice, the outstanding balance will be collected when the Billing Information is updated.

If you want to create an account at the same time, you should use the Account API end-point instead and include Billing Information with your request.

The required address fields will correspond to the address requirements configured for your site.
If you need to set a back dated subscription authorziation date for the NACHA three year re-authorization rule, do so on the Create Subscription call using the "bank_account_authorized_at" attribute.

Please note

Recurly strongly recommends using a token generated by Recurly.js rather than directly handling your customer's bank account details.

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php

try {
  $billing_info = new Recurly_BillingInfo();
  $billing_info->account_code = 'b6f5783';
  $billing_info->name_on_account = 'Acme Inc.';
  $billing_info->routing_number = '065400137';
  $billing_info->account_number = '4444000000005555';
  $billing_info->account_type = 'checking';
  $billing_info->address1 = '123 Main St.';
  $billing_info->city = 'San Francisco';
  $billing_info->state ='CA';
  $billing_info->country = 'US';
  $billing_info->zip = '94105';
  $billing_info->create();

  print "Billing Info: $billing_info";
} catch (Recurly_ValidationError $e) {
  // The data or bank account are invalid
  print "Invalid data or card: $e";
} catch (Recurly_NotFoundError $e) {
  // Could not find account
  print "Account Not Found: $e";
}
account = Recurly::Account.find('1')
account.billing_info = {
  name_on_account: 'Acme, Inc.',
  routing_number: '065400137',
  account_number: '4444000000005555',
  address1: '123 Main St.',
  city: 'San Francisco',
  state: 'CA',
  country: 'US',
  zip: '94105'
}
account.billing_info.save!
account = Account.get('1')
billing_info = recurly.BillingInfo(
  name_on_account = 'Acme, Inc.',
  routing_number = '065400137',
  account_number = '4444000000005555',
  account_type = 'checking',
  address1 = '123 Main St.',
  city = 'San Francisco',
  state ='CA',
  country = 'US',
  zip = '94105'
  )
account.update_billing_info(billing_info)
var account = Accounts.Get("1");
var info = new BillingInfo(account);
info.NameOnAccount = "Acme, Inc.";
info.RoutingNumber = "065400137";
info.AccountNumber = "4444000000005555";
info.AccountType = BillingInfo.BankAccountType.Checking;
info.Address1 = "123 Main St.";
info.City = "San Francisco";
info.State = "CA";
info.Country = "US";
info.PostalCode = "94105";
info.Create();
<billing_info>
  <name_on_account>Acme, Inc.</name_on_account>
  <address1>123 Main St.</address1>
  <address2 nil="nil"></address2>
  <city>San Francisco</city>
  <state>CA</state>
  <zip>94105</zip>
  <country>US</country>
  <routing_number>065400137</routing_number>
  <account_number>4444000000005555</account_number>
  <account_type>checking</account_type>
  <ip_address>127.0.0.1</ip_address>
</billing_info>

Result Format

<billing_info href="https://your-subdomain.recurly.com/v2/accounts/1/billing_info" type="bank_account">
  <account href="https://your-subdomain.recurly.com/v2/accounts/1"/>
  <name_on_account>Acme, Inc.</name_on_account>
  <first_name nil="nil"></first_name>
  <last_name nil="nil"></last_name>
  <company nil="nil"></company>
  <address1>123 Main St.</address1>
  <address2 nil="nil"></address2>
  <city>San Francisco</city>
  <state>CA</state>
  <zip>94105</zip>
  <country>US</country>
  <phone></phone>
  <vat_number></vat_number>
  <ip_address>127.0.0.1</ip_address>
  <ip_address_country>US</ip_address_country>
  <account_type>checking</account_type>
  <last_four>5555</last_four>
  <routing_number>065400137</routing_number>
</billing_info>


{"__v":0,"_id":"578e7c5ab434c30e0035bf76","api":{"examples":{"codes":[{"name":"","code":"<?php\n\ntry {\n  $billing_info = new Recurly_BillingInfo();\n  $billing_info->account_code = 'b6f5783';\n  $billing_info->first_name = 'Verena';\n  $billing_info->last_name = 'Example';\n  $billing_info->paypal_billing_agreement_id = 'BA-0HS87238YB688345C';\n  $billing_info->create();\n\n  print \"Billing Info: $billing_info\";\n} catch (Recurly_ValidationError $e) {\n  // The paypal billing agreement provided is invalid\n  print \"Invalid paypal billing agreement: $e\";\n} catch (Recurly_NotFoundError $e) {\n  // Could not find account\n  print \"Not Found: $e\";\n}","language":"php"},{"code":"account = Recurly::Account.find('1')\naccount.billing_info = {\n  :first_name         => 'Verena',\n  :last_name          => 'Example',\n  :paypal_billing_agreement_id             => 'BA-0HS87238YB688345C'\n}\naccount.billing_info.save!","language":"ruby"},{"code":"account = Account.get('1')\nbilling_info = account.billing_info\nbilling_info.first_name = 'Verena'\nbilling_info.last_name = 'Example'\nbilling_info.paypal_billing_agreement_id = 'BA-0HS87238YB688345C'\naccount.update_billing_info(billing_info)","language":"python"},{"code":"var account = Accounts.Get(\"1\");\nvar info = new BillingInfo(account);\ninfo.FirstName = \"Verana\";\ninfo.LastName = \"Example\";\ninfo.PaypalBillingAgreementId = \"BA-0HS87238YB688345C\";\ninfo.Create();","language":"csharp"},{"code":"<billing_info>\n  <first_name>Verena</first_name>\n  <last_name>Example</last_name>\n  <address1>123 Main St.</address1>\n  <address2 nil=\"nil\"></address2>\n  <city>San Francisco</city>\n  <state>CA</state>\n  <zip>94105</zip>\n  <country>US</country>\n  <paypal_billing_agreement_id>BA-0HS87238YB688345C</paypal_billing_agreement_id>\n  <ip_address>127.0.0.1</ip_address>\n</billing_info>","language":"xml"}]},"results":{"codes":[{"name":"","code":"<billing_info href=\"https://your-subdomain.recurly.com/v2/accounts/1/billing_info\" type=\"credit_card\">\n  <account href=\"https://your-subdomain.recurly.com/v2/accounts/1\"/>\n  <first_name>Verena</first_name>\n  <last_name>Example</last_name>\n  <company nil=\"nil\"></company>\n  <address1>123 Main St.</address1>\n  <address2 nil=\"nil\"></address2>\n  <city>San Francisco</city>\n  <state>CA</state>\n  <zip>94105</zip>\n  <country>US</country>\n  <phone nil=\"nil\"></phone>\n  <paypal_billing_agreement_id>BA-0HS87238YB688345C</paypal_billing_agreement_id>\n</billing_info>","language":"xml","status":201}]},"settings":"","auth":"required","params":[{"_id":"55944fab5c9eaa2300a8633c","ref":"","in":"path","required":true,"desc":"Account's unique code.","default":"","type":"string","name":"account_code"},{"_id":"5581d09a8625220d00429e4d","ref":"","in":"body","required":true,"desc":"First name","default":"","type":"string","name":"first_name"},{"_id":"5581d09a8625220d00429e4c","ref":"","in":"body","required":true,"desc":"Last name","default":"","type":"string","name":"last_name"},{"_id":"5581d09a8625220d00429e4b","ref":"","in":"body","required":false,"desc":"Address line 1, recommended for address validation","default":"","type":"string","name":"address1"},{"_id":"5581d09a8625220d00429e4a","ref":"","in":"body","required":false,"desc":"Address line 2.","default":"","type":"string","name":"address2"},{"_id":"5581d09a8625220d00429e49","ref":"","in":"body","required":false,"desc":"City","default":"","type":"string","name":"city"},{"_id":"5581d09a8625220d00429e48","ref":"","in":"body","required":false,"desc":"State","default":"","type":"string","name":"state"},{"_id":"5581d09a8625220d00429e47","ref":"","in":"body","required":false,"desc":"Country, [2-letter ISO code](http://www.iso.org/iso/country_names_and_code_elements) **STRONGLY RECOMMENDED**","default":"","type":"string","name":"country"},{"_id":"5581d09a8625220d00429e46","ref":"","in":"body","required":false,"desc":"Zip or postal code, recommended for address validation","default":"","type":"string","name":"zip"},{"_id":"5581d09a8625220d00429e45","ref":"","in":"body","required":false,"desc":"Phone number","default":"","type":"string","name":"phone"},{"_id":"5723d8f2110e570e00486c2f","ref":"","in":"body","required":false,"desc":"Paypal's billing agreement","default":"","type":"string","name":"paypal_billing_agreement_id"},{"_id":"5581d09a8625220d00429e44","ref":"","in":"body","required":false,"desc":"Customer's VAT Number","default":"","type":"string","name":"vat_number"},{"_id":"56c3c1ce70187b17005f4395","ref":"","in":"body","required":false,"desc":"Currency in which invoices will be posted. Only applicable if this account is enrolled in a plan has a different currency than your site's default.","default":"","type":"string","name":"currency"},{"_id":"5581d09a8625220d00429e43","ref":"","in":"body","required":false,"desc":"Customer's IP address when updating their Billing Information **STRONGLY RECOMMENDED**","default":"","type":"string","name":"ip_address"}],"url":"/accounts/:account_code/billing_info"},"body":"Instead of using a token generated by Recurly.js, you can instead submit full credit card and address information when creating Billing Information.\n\nWhen Billing Information is submitted, it is only saved if valid. If the account has a past due invoice, the outstanding balance will be collected to validate the Billing Information.\n\nIf you want to create an account at the same time, you should use the [Account API end-point](https://docs.recurly.com/api/accounts#create-account) instead and include Billing Information with your request.\n\nThe required address fields will correspond to the **address requirements** configured for your site.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Recurly strongly recommends using a token [generated by Recurly.js](https://docs.recurly.com/js/#getting-a-token) rather than directly handling your customer's credit card details.\",\n  \"title\": \"Please note\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"This API end-point may be used to import Billing Information without security codes (CVV). Recurly recommends requiring CVV from your customers when collecting new or updated Billing Information.\",\n  \"title\": \"Please note\"\n}\n[/block]","category":"578e7c59b434c30e0035bf2c","createdAt":"2016-04-29T21:58:10.697Z","excerpt":"Creates the account's Billing Information using external token for example: Paypal billing agreement","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"create-an-accounts-billing-info-using-external-token","sync_unique":"","title":"Create Account's Billing Info (using external token)","type":"post","updates":[],"user":"56c3c01334df460d00c2beb3","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

postCreate Account's Billing Info (using external token)

Creates the account's Billing Information using external token for example: Paypal billing agreement

account_code:
required
string
Account's unique code.
first_name:
required
string
First name
last_name:
required
string
Last name
address1:
string
Address line 1, recommended for address validation
address2:
string
Address line 2.
city:
string
City
state:
string
State
country:
string
Country, [2-letter ISO code](http://www.iso.org/iso/country_names_and_code_elements) **STRONGLY RECOMMENDED**
zip:
string
Zip or postal code, recommended for address validation
phone:
string
Phone number
paypal_billing_agreement_id:
string
Paypal's billing agreement
vat_number:
string
Customer's VAT Number
currency:
string
Currency in which invoices will be posted. Only applicable if this account is enrolled in a plan has a different currency than your site's default.
ip_address:
string
Customer's IP address when updating their Billing Information **STRONGLY RECOMMENDED**

Instead of using a token generated by Recurly.js, you can instead submit full credit card and address information when creating Billing Information.

When Billing Information is submitted, it is only saved if valid. If the account has a past due invoice, the outstanding balance will be collected to validate the Billing Information.

If you want to create an account at the same time, you should use the Account API end-point instead and include Billing Information with your request.

The required address fields will correspond to the address requirements configured for your site.

Please note

Recurly strongly recommends using a token generated by Recurly.js rather than directly handling your customer's credit card details.

Please note

This API end-point may be used to import Billing Information without security codes (CVV). Recurly recommends requiring CVV from your customers when collecting new or updated Billing Information.

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php

try {
  $billing_info = new Recurly_BillingInfo();
  $billing_info->account_code = 'b6f5783';
  $billing_info->first_name = 'Verena';
  $billing_info->last_name = 'Example';
  $billing_info->paypal_billing_agreement_id = 'BA-0HS87238YB688345C';
  $billing_info->create();

  print "Billing Info: $billing_info";
} catch (Recurly_ValidationError $e) {
  // The paypal billing agreement provided is invalid
  print "Invalid paypal billing agreement: $e";
} catch (Recurly_NotFoundError $e) {
  // Could not find account
  print "Not Found: $e";
}
account = Recurly::Account.find('1')
account.billing_info = {
  :first_name         => 'Verena',
  :last_name          => 'Example',
  :paypal_billing_agreement_id             => 'BA-0HS87238YB688345C'
}
account.billing_info.save!
account = Account.get('1')
billing_info = account.billing_info
billing_info.first_name = 'Verena'
billing_info.last_name = 'Example'
billing_info.paypal_billing_agreement_id = 'BA-0HS87238YB688345C'
account.update_billing_info(billing_info)
var account = Accounts.Get("1");
var info = new BillingInfo(account);
info.FirstName = "Verana";
info.LastName = "Example";
info.PaypalBillingAgreementId = "BA-0HS87238YB688345C";
info.Create();
<billing_info>
  <first_name>Verena</first_name>
  <last_name>Example</last_name>
  <address1>123 Main St.</address1>
  <address2 nil="nil"></address2>
  <city>San Francisco</city>
  <state>CA</state>
  <zip>94105</zip>
  <country>US</country>
  <paypal_billing_agreement_id>BA-0HS87238YB688345C</paypal_billing_agreement_id>
  <ip_address>127.0.0.1</ip_address>
</billing_info>

Result Format

<billing_info href="https://your-subdomain.recurly.com/v2/accounts/1/billing_info" type="credit_card">
  <account href="https://your-subdomain.recurly.com/v2/accounts/1"/>
  <first_name>Verena</first_name>
  <last_name>Example</last_name>
  <company nil="nil"></company>
  <address1>123 Main St.</address1>
  <address2 nil="nil"></address2>
  <city>San Francisco</city>
  <state>CA</state>
  <zip>94105</zip>
  <country>US</country>
  <phone nil="nil"></phone>
  <paypal_billing_agreement_id>BA-0HS87238YB688345C</paypal_billing_agreement_id>
</billing_info>


{"__v":0,"_id":"578e7c5ab434c30e0035bf72","api":{"examples":{"codes":[{"name":"","code":"<?php\n\ntry {\n  $billing_info = Recurly_BillingInfo::get('b6f5783');\n  print \"Billing Info: $billing_info\";\n} catch (Recurly_NotFoundError $e) {\n  // Could not find account or account\n  // doesn't have billing info\n  print \"Not found: $e\";\n}","language":"php"},{"code":"account = Recurly::Account.find('1')\nbilling_info = account.billing_info","language":"ruby"},{"code":"account = Account.get('1')\nbilling_info = account.billing_info","language":"python"},{"code":"var account = Accounts.Get(\"1\");\nvar info = account.BillingInfo;","language":"csharp"}]},"results":{"codes":[{"name":"","code":"<billing_info href=\"https://your-subdomain.recurly.com/v2/accounts/1/billing_info\" type=\"credit_card\">\n  <account href=\"https://your-subdomain.recurly.com/v2/accounts/1\"/>\n  <first_name>Verena</first_name>\n  <last_name>Example</last_name>\n  <company nil=\"nil\"/>\n  <address1>123 Main St.</address1>\n  <address2 nil=\"nil\"/>\n  <city>San Francisco</city>\n  <state>CA</state>\n  <zip>94105</zip>\n  <country>US</country>\n  <phone nil=\"nil\"/>\n  <vat_number nil=\"nil\"/>\n  <ip_address>127.0.0.1</ip_address>\n  <ip_address_country nil=\"nil\"/>\n  <card_type>Visa</card_type>\n  <year type=\"integer\">2019</year>\n  <month type=\"integer\">11</month>\n  <first_six>411111</first_six>\n  <last_four>1111</last_four>\n</billing_info>","language":"xml","status":200}]},"settings":"","auth":"required","params":[{"_id":"55944f815c9eaa2300a8633a","ref":"","in":"path","required":true,"desc":"Account's unique code.","default":"","type":"string","name":"account_code"},{"_id":"5581ce0ea5474a0d00d946a1","ref":"","in":"query","required":false,"desc":"First name","default":"","type":"string","name":"first_name"},{"_id":"5581ce0ea5474a0d00d946a0","ref":"","in":"query","required":false,"desc":"Last name","default":"","type":"string","name":"last_name"},{"_id":"5646783bc7687d0d00739f3f","ref":"","in":"query","required":false,"desc":"Company name","default":"","type":"string","name":"company"},{"_id":"5581ce0ea5474a0d00d9469f","ref":"","in":"query","required":false,"desc":"Address line 1","default":"","type":"string","name":"address1"},{"_id":"5581ce0ea5474a0d00d9469e","ref":"","in":"query","required":false,"desc":"Address line 2","default":"","type":"string","name":"address2"},{"_id":"5581ce0ea5474a0d00d9469d","ref":"","in":"query","required":false,"desc":"City","default":"","type":"string","name":"city"},{"_id":"5581ce0ea5474a0d00d94695","ref":"","in":"query","required":false,"desc":"Credit card number, last four digits","default":"","type":"int","name":"last_four"},{"_id":"5581ce0ea5474a0d00d9469c","ref":"","in":"query","required":false,"desc":"State","default":"","type":"string","name":"state"},{"_id":"5581ce0ea5474a0d00d9469b","ref":"","in":"query","required":false,"desc":"Country, [2-letter ISO code](http://www.iso.org/iso/country_names_and_code_elements)","default":"","type":"string","name":"country"},{"_id":"5581ce0ea5474a0d00d9469a","ref":"","in":"query","required":false,"desc":"Zip or postal code","default":"","type":"string","name":"zip"},{"_id":"5581ce0ea5474a0d00d94699","ref":"","in":"query","required":false,"desc":"Customer's VAT number","default":"","type":"string","name":"vat_number"},{"_id":"5581ce0ea5474a0d00d94698","ref":"","in":"query","required":false,"desc":"Customer's IP address when updating their billing information","default":"","type":"string","name":"ip_address"},{"_id":"5581ce0ea5474a0d00d94697","ref":"","in":"query","required":false,"desc":"Country of IP address, if known by Recurly","default":"","type":"string","name":"ip_address_country"},{"_id":"5581ce0ea5474a0d00d94696","ref":"","in":"query","required":false,"desc":"Credit card number, first six digits","default":"","type":"int","name":"first_six"},{"_id":"5581ce0ea5474a0d00d94694","ref":"","in":"query","required":false,"desc":"Visa, MasterCard, American Express, Discover, JCB, etc","default":"","type":"string","name":"card_type"},{"_id":"5581ce0ea5474a0d00d94693","ref":"","in":"query","required":false,"desc":"Expiration month","default":"","type":"int","name":"month"},{"_id":"5581ce0ea5474a0d00d94692","ref":"","in":"query","required":false,"desc":"Expiration year","default":"","type":"int","name":"year"},{"_id":"5581ce0ea5474a0d00d94691","ref":"","in":"query","required":false,"desc":"PayPal Billing Agreement ID","default":"","type":"string","name":"paypal_billing_agreement_id"},{"_id":"5581ce0ea5474a0d00d94690","ref":"","in":"query","required":false,"desc":"Amazon Billing Agreement ID","default":"","type":"string","name":"amazon_billing_agreement_id"},{"_id":"5581ce0ea5474a0d00d9468f","ref":"","in":"query","required":false,"desc":"The name associated with the account. This may be a person's full name or a business name. name_on_account is used instead of first_name and last_name if the payment method is Bank Account.","default":"","type":"string","name":"name_on_account"},{"_id":"5581ce0ea5474a0d00d9468e","ref":"","in":"query","required":false,"desc":"U.S. bank account routing number","default":"","type":"int","name":"routing_number"},{"_id":"5581ce0ea5474a0d00d9468d","ref":"","in":"query","required":false,"desc":"Bank account number","default":"","type":"int","name":"account_number"},{"_id":"5581ce0ea5474a0d00d9468c","ref":"","in":"query","required":false,"desc":"Either 'checking' or 'savings'","default":"","type":"string","name":"account_type"},{"_id":"57606120dc8f9f0e00c5977c","ref":"","in":"query","required":false,"desc":"A 3-letter currency to override your site default (if you know this, setting it may save you an extra verification call)","default":"","type":"string","name":"currency"}],"url":"/accounts/:account_code/billing_info"},"body":"","category":"578e7c59b434c30e0035bf2c","createdAt":"2015-06-17T19:44:14.605Z","excerpt":"Returns only the account's current billing information.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"lookup-an-accounts-billing-info","sync_unique":"","title":"Lookup Account's Billing Info","type":"get","updates":[],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

getLookup Account's Billing Info

Returns only the account's current billing information.

account_code:
required
string
Account's unique code.
first_name:
string
First name
last_name:
string
Last name
company:
string
Company name
address1:
string
Address line 1
address2:
string
Address line 2
city:
string
City
last_four:
integer
Credit card number, last four digits
state:
string
State
country:
string
Country, [2-letter ISO code](http://www.iso.org/iso/country_names_and_code_elements)
zip:
string
Zip or postal code
vat_number:
string
Customer's VAT number
ip_address:
string
Customer's IP address when updating their billing information
ip_address_country:
string
Country of IP address, if known by Recurly
first_six:
integer
Credit card number, first six digits
card_type:
string
Visa, MasterCard, American Express, Discover, JCB, etc
month:
integer
Expiration month
year:
integer
Expiration year
paypal_billing_agreement_id:
string
PayPal Billing Agreement ID
amazon_billing_agreement_id:
string
Amazon Billing Agreement ID
name_on_account:
string
The name associated with the account. This may be a person's full name or a business name. name_on_account is used instead of first_name and last_name if the payment method is Bank Account.
routing_number:
integer
U.S. bank account routing number
account_number:
integer
Bank account number
account_type:
string
Either 'checking' or 'savings'
currency:
string
A 3-letter currency to override your site default (if you know this, setting it may save you an extra verification call)

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php

try {
  $billing_info = Recurly_BillingInfo::get('b6f5783');
  print "Billing Info: $billing_info";
} catch (Recurly_NotFoundError $e) {
  // Could not find account or account
  // doesn't have billing info
  print "Not found: $e";
}
account = Recurly::Account.find('1')
billing_info = account.billing_info
account = Account.get('1')
billing_info = account.billing_info
var account = Accounts.Get("1");
var info = account.BillingInfo;

Result Format

<billing_info href="https://your-subdomain.recurly.com/v2/accounts/1/billing_info" type="credit_card">
  <account href="https://your-subdomain.recurly.com/v2/accounts/1"/>
  <first_name>Verena</first_name>
  <last_name>Example</last_name>
  <company nil="nil"/>
  <address1>123 Main St.</address1>
  <address2 nil="nil"/>
  <city>San Francisco</city>
  <state>CA</state>
  <zip>94105</zip>
  <country>US</country>
  <phone nil="nil"/>
  <vat_number nil="nil"/>
  <ip_address>127.0.0.1</ip_address>
  <ip_address_country nil="nil"/>
  <card_type>Visa</card_type>
  <year type="integer">2019</year>
  <month type="integer">11</month>
  <first_six>411111</first_six>
  <last_four>1111</last_four>
</billing_info>


{"__v":0,"_id":"578e7c5ab434c30e0035bf77","api":{"examples":{"codes":[{"name":"","code":"<?php\n\ntry {\n  $billing_info = new Recurly_BillingInfo();\n  $billing_info->account_code = 'b6f5783';\n  $billing_info->token_id = '7z6furn4jvb9'; // From Recurly.js\n  $billing_info->update();\n\n  print \"Billing Info: $billing_info\";\n} catch (Recurly_NotFoundError $e) {\n  // Could not find account or token is invalid or expired\n  print \"Not Found: $e\";\n}","language":"php"},{"code":"account = Recurly::Account.find('1')\naccount.billing_info.token_id = 'TOKEN_ID'\naccount.billing_info.save!","language":"ruby"},{"code":"account = Account.get('1')\nbilling_info = account.billing_info\nbilling_info.token_id = 'TOKEN_ID'\naccount.update_billing_info(billing_info)","language":"python"},{"code":"var account = Accounts.Get(\"1\");\nvar info = new BillingInfo(account);\ninfo.TokenId = \"TOKEN_ID\";\ninfo.Update();","language":"csharp"},{"code":"<billing_info>\n  <token_id>TOKEN_ID</token_id>\n</billing_info>","language":"xml"}]},"results":{"codes":[{"name":"","code":"<billing_info href=\"https://your-subdomain.recurly.com/v2/accounts/1/billing_info\" type=\"credit_card\">\n  <account href=\"https://your-subdomain.recurly.com/v2/accounts/1\"/>\n  <first_name>Verena</first_name>\n  <last_name>Example</last_name>\n  <company nil=\"nil\"></company>\n  <address1>123 Main St.</address1>\n  <address2 nil=\"nil\"></address2>\n  <city>San Francisco</city>\n  <state>CA</state>\n  <zip>94105</zip>\n  <country>US</country>\n  <phone nil=\"nil\"></phone>\n  <card_type>Visa</card_type>\n  <year type=\"integer\">2019</year>\n  <month type=\"integer\">11</month>\n  <first_six>411111</first_six>\n  <last_four>1111</last_four>\n</billing_info>","language":"xml","status":200}]},"settings":"","auth":"required","params":[{"_id":"55944fca5c9eaa2300a8633e","ref":"","in":"path","required":true,"desc":"Account's unique code.","default":"","type":"string","name":"account_code"},{"_id":"5581d2f8a5474a0d00d946bc","ref":"","in":"body","required":true,"desc":"A token [generated by Recurly.js](https://docs.recurly.com/js/#getting-a-token).","default":"","type":"string","name":"token_id"},{"_id":"56d0e7b07c2e100b000afa25","ref":"","in":"body","required":false,"desc":"Currency in which invoices will be posted. Only applicable if this account is enrolled in a plan has a different currency than your site's default.","default":"","type":"string","name":"currency"}],"url":"/accounts/:account_code/billing_info"},"body":"[Recurly.js](https://js.recurly.com/) allows you to collect customer Billing Information and tokenize it, preventing your servers from having to handle credit card information. When you send these tokens to Recurly through our API, we unpack the token and update Billing Information accordingly.\n\nWhen Billing Information is updated, it is only saved if valid. If the account has a past due invoice, the outstanding balance will be collected to validate the Billing Information.\n\nIf you want to create an account at the same time, you should use the [Account API end-point](https://docs.recurly.com/api/accounts#create-account) instead and include billing info with your request.","category":"578e7c59b434c30e0035bf2c","createdAt":"2015-06-17T20:05:12.621Z","excerpt":"Updates an account's Billing Information using a token [generated by Recurly.js](https://docs.recurly.com/js/#getting-a-token). Returns the account's current Billing Information.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"update-an-accounts-billing-info-token","sync_unique":"","title":"Update Account's Billing Info (Token)","type":"put","updates":[],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

putUpdate Account's Billing Info (Token)

Updates an account's Billing Information using a token [generated by Recurly.js](https://docs.recurly.com/js/#getting-a-token). Returns the account's current Billing Information.

account_code:
required
string
Account's unique code.
token_id:
required
string
A token [generated by Recurly.js](https://docs.recurly.com/js/#getting-a-token).
currency:
string
Currency in which invoices will be posted. Only applicable if this account is enrolled in a plan has a different currency than your site's default.

Recurly.js allows you to collect customer Billing Information and tokenize it, preventing your servers from having to handle credit card information. When you send these tokens to Recurly through our API, we unpack the token and update Billing Information accordingly.

When Billing Information is updated, it is only saved if valid. If the account has a past due invoice, the outstanding balance will be collected to validate the Billing Information.

If you want to create an account at the same time, you should use the Account API end-point instead and include billing info with your request.

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php

try {
  $billing_info = new Recurly_BillingInfo();
  $billing_info->account_code = 'b6f5783';
  $billing_info->token_id = '7z6furn4jvb9'; // From Recurly.js
  $billing_info->update();

  print "Billing Info: $billing_info";
} catch (Recurly_NotFoundError $e) {
  // Could not find account or token is invalid or expired
  print "Not Found: $e";
}
account = Recurly::Account.find('1')
account.billing_info.token_id = 'TOKEN_ID'
account.billing_info.save!
account = Account.get('1')
billing_info = account.billing_info
billing_info.token_id = 'TOKEN_ID'
account.update_billing_info(billing_info)
var account = Accounts.Get("1");
var info = new BillingInfo(account);
info.TokenId = "TOKEN_ID";
info.Update();
<billing_info>
  <token_id>TOKEN_ID</token_id>
</billing_info>

Result Format

<billing_info href="https://your-subdomain.recurly.com/v2/accounts/1/billing_info" type="credit_card">
  <account href="https://your-subdomain.recurly.com/v2/accounts/1"/>
  <first_name>Verena</first_name>
  <last_name>Example</last_name>
  <company nil="nil"></company>
  <address1>123 Main St.</address1>
  <address2 nil="nil"></address2>
  <city>San Francisco</city>
  <state>CA</state>
  <zip>94105</zip>
  <country>US</country>
  <phone nil="nil"></phone>
  <card_type>Visa</card_type>
  <year type="integer">2019</year>
  <month type="integer">11</month>
  <first_six>411111</first_six>
  <last_four>1111</last_four>
</billing_info>


{"__v":0,"_id":"578e7c5ab434c30e0035bf78","api":{"examples":{"codes":[{"name":"","code":"<?php\n\ntry {\n  $billing_info = new Recurly_BillingInfo();\n  $billing_info->account_code = 'b6f5783';\n  $billing_info->first_name = 'Verena';\n  $billing_info->last_name = 'Example';\n  $billing_info->number = '4111-1111-1111-1111';\n  $billing_info->verification_value = '123';\n  $billing_info->month = 11;\n  $billing_info->year = 2017;\n  $billing_info->update();\n\n  print \"Billing Info: $billing_info\";\n} catch (Recurly_ValidationError $e) {\n  // The data or card are invalid\n  print \"Invalid data or card: $e\";\n} catch (Recurly_NotFoundError $e) {\n  // Could not find account\n  print \"Not Found: $e\";\n}","language":"php"},{"code":"account = Recurly::Account.find('1')\naccount.billing_info = {\n  :first_name         => 'Verena',\n  :last_name          => 'Example',\n  :number             => '4111-1111-1111-1111',\n  :verification_value => '123',\n  :month              => 11,\n  :year               => 2015\n}\naccount.billing_info.save!","language":"ruby"},{"code":"account = Account.get('1')\nbilling_info = account.billing_info\nbilling_info.first_name = 'Verena'\nbilling_info.last_name = 'Example'\nbilling_info.number = '4111-1111-1111-1111'\nbilling_info.verification_value = '123'\nbilling_info.month = 11\nbilling_info.year = 2015\naccount.update_billing_info(billing_info)","language":"python"},{"code":"var account = Accounts.Get(\"1\");\nvar info = new BillingInfo(account);\ninfo.FirstName = \"Verana\";\ninfo.LastName = \"Example\";\ninfo.CreditCardNumber = \"4111-111-1111-1111\";\ninfo.VerificationValue = \"123\";\ninfo.ExpirationMonth = 11;\ninfo.ExpirationYear = 2015;\ninfo.Update();","language":"csharp"},{"code":"<billing_info>\n  <first_name>Verena</first_name>\n  <last_name>Example</last_name>\n  <number>4111-1111-1111-1111</number>\n  <verification_value>123</verification_value>\n  <month>11</month>\n  <year>2019</year>\n  <ip_address>127.0.0.1</ip_address>\n</billing_info>","language":"xml"}]},"results":{"codes":[{"name":"","code":"<billing_info href=\"https://your-subdomain.recurly.com/v2/accounts/1/billing_info\" type=\"credit_card\">\n  <account href=\"https://your-subdomain.recurly.com/v2/accounts/1\"/>\n  <first_name>Verena</first_name>\n  <last_name>Example</last_name>\n  <company nil=\"nil\"/>\n  <address1>123 Main St.</address1>\n  <address2 nil=\"nil\"/>\n  <city>San Francisco</city>\n  <state>CA</state>\n  <zip>94105</zip>\n  <country>US</country>\n  <phone nil=\"nil\"/>\n  <vat_number nil=\"nil\"/>\n  <ip_address>127.0.0.1</ip_address>\n  <ip_address_country nil=\"nil\"/>\n  <card_type>Visa</card_type>\n  <year type=\"integer\">2019</year>\n  <month type=\"integer\">11</month>\n  <first_six>411111</first_six>\n  <last_four>1111</last_four>\n</billing_info>","language":"xml","status":200}]},"settings":"","auth":"required","params":[{"_id":"55944fdb5c9eaa2300a8633f","ref":"","in":"path","required":true,"desc":"Account's unique code.","default":"","type":"string","name":"account_code"},{"_id":"5581d46f8625220d00429e81","ref":"","in":"body","required":false,"desc":"First name","default":"","type":"string","name":"first_name"},{"_id":"5581d46f8625220d00429e80","ref":"","in":"body","required":false,"desc":"Last name","default":"","type":"string","name":"last_name"},{"_id":"5581d46f8625220d00429e7f","ref":"","in":"body","required":false,"desc":"Address line 1, recommended for address validation","default":"","type":"string","name":"address1"},{"_id":"5581d46f8625220d00429e7e","ref":"","in":"body","required":false,"desc":"Address line 2","default":"","type":"string","name":"address2"},{"_id":"5581d46f8625220d00429e7d","ref":"","in":"body","required":false,"desc":"City","default":"","type":"string","name":"city"},{"_id":"5581d46f8625220d00429e7c","ref":"","in":"body","required":false,"desc":"State","default":"","type":"string","name":"state"},{"_id":"5581d46f8625220d00429e7b","ref":"","in":"body","required":false,"desc":"Country, [2-letter ISO code](http://www.iso.org/iso/country_names_and_code_elements) **STRONGLY RECOMMENDED**","default":"","type":"string","name":"country"},{"_id":"5581d46f8625220d00429e7a","ref":"","in":"body","required":false,"desc":"Zip or postal code, recommended for address validation","default":"","type":"string","name":"zip"},{"_id":"5581d46f8625220d00429e79","ref":"","in":"body","required":false,"desc":"Phone number","default":"","type":"string","name":"phone"},{"_id":"5581d46f8625220d00429e78","ref":"","in":"body","required":false,"desc":"Customer's VAT Number","default":"","type":"string","name":"vat_number"},{"_id":"5581d46f8625220d00429e76","ref":"","in":"body","required":false,"desc":"Credit card number, spaces and dashes are accepted","default":"","type":"string","name":"number"},{"_id":"5581d46f8625220d00429e75","ref":"","in":"body","required":false,"desc":"Expiration month","default":"","type":"string","name":"month"},{"_id":"5581d46f8625220d00429e74","ref":"","in":"body","required":false,"desc":"Expiration year","default":"","type":"string","name":"year"},{"_id":"5581d46f8625220d00429e73","ref":"","in":"body","required":false,"desc":"Security code or CVV, 3-4 digits **STRONGLY RECOMMENDED**","default":"","type":"string","name":"verification_value"},{"_id":"5581d46f8625220d00429e77","ref":"","in":"body","required":false,"desc":"Customer's IP address when updating their Billing Information **STRONGLY RECOMMENDED**","default":"","type":"string","name":"ip_address"},{"_id":"56c3c273c0c4630d004e86a8","ref":"","in":"body","required":false,"desc":"Currency in which invoices will be posted. Only applicable if this account is enrolled in a plan has a different currency than your site's default.","default":"","type":"string","name":"currency"}],"url":"/accounts/:account_code/billing_info"},"body":"Instead of using a token generated by Recurly.js, you can instead submit full credit card and address information when updating Billing Information. Non PCI sensitive billing info can be updated by api without re-submitting the token. This can be done in two ways: 1)Through the billing info api (docs. link: https://docs.recurly.com/api/billing-info#update-billing-info-credit-card ) whereby you submit only the information that needs to be updated. In that way, all other information remains unchanged on the account. 2) Providing the end user a unique url link to their billing info page, where they can update their own billing info securly. This link can be found in the configuration window of the subscriber's account. https://SUBDOMAIN.recurly.com/accounts/:account_code/edit. You will see a hosted billing information URL that takes the user to their billing site hosted by Recurly.\n\nWhen Billing Information is updated, it is only saved if valid. If the account has a past due invoice, the outstanding balance will be collected to validate the Billing Information.\n\nIf you want to create an account at the same time, you should use the [Account API](https://docs.recurly.com/api/accounts#create-account) end-point instead and include Billing Information with your request.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Please note\",\n  \"body\": \"This API end-point may be used to import Billing Information without security codes (CVV). Recurly recommends requiring CVV from your customers when collecting new or updated Billing Information.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Recurly strongly recommends using a token [generated by Recurly.js](https://docs.recurly.com/js/#getting-a-token) rather than directly handling your customer's credit card details. You can, however, use this API call to update the billing address associated with an account.\",\n  \"title\": \"Please note\"\n}\n[/block]","category":"578e7c59b434c30e0035bf2c","createdAt":"2015-06-17T20:11:27.639Z","excerpt":"Returns the account's updated Billing Information.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":6,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"update-an-accounts-billing-info-credit-card","sync_unique":"","title":"Update Account's Billing Info (Credit Card)","type":"put","updates":["55d337a4f77e6d0d00b1afab","562945ab1a92870d0002c302"],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

putUpdate Account's Billing Info (Credit Card)

Returns the account's updated Billing Information.

account_code:
required
string
Account's unique code.
first_name:
string
First name
last_name:
string
Last name
address1:
string
Address line 1, recommended for address validation
address2:
string
Address line 2
city:
string
City
state:
string
State
country:
string
Country, [2-letter ISO code](http://www.iso.org/iso/country_names_and_code_elements) **STRONGLY RECOMMENDED**
zip:
string
Zip or postal code, recommended for address validation
phone:
string
Phone number
vat_number:
string
Customer's VAT Number
number:
string
Credit card number, spaces and dashes are accepted
month:
string
Expiration month
year:
string
Expiration year
verification_value:
string
Security code or CVV, 3-4 digits **STRONGLY RECOMMENDED**
ip_address:
string
Customer's IP address when updating their Billing Information **STRONGLY RECOMMENDED**
currency:
string
Currency in which invoices will be posted. Only applicable if this account is enrolled in a plan has a different currency than your site's default.

Instead of using a token generated by Recurly.js, you can instead submit full credit card and address information when updating Billing Information. Non PCI sensitive billing info can be updated by api without re-submitting the token. This can be done in two ways: 1)Through the billing info api (docs. link: https://docs.recurly.com/api/billing-info#update-billing-info-credit-card ) whereby you submit only the information that needs to be updated. In that way, all other information remains unchanged on the account. 2) Providing the end user a unique url link to their billing info page, where they can update their own billing info securly. This link can be found in the configuration window of the subscriber's account. https://SUBDOMAIN.recurly.com/accounts/:account_code/edit. You will see a hosted billing information URL that takes the user to their billing site hosted by Recurly.

When Billing Information is updated, it is only saved if valid. If the account has a past due invoice, the outstanding balance will be collected to validate the Billing Information.

If you want to create an account at the same time, you should use the Account API end-point instead and include Billing Information with your request.

Please note

This API end-point may be used to import Billing Information without security codes (CVV). Recurly recommends requiring CVV from your customers when collecting new or updated Billing Information.

Please note

Recurly strongly recommends using a token generated by Recurly.js rather than directly handling your customer's credit card details. You can, however, use this API call to update the billing address associated with an account.

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php

try {
  $billing_info = new Recurly_BillingInfo();
  $billing_info->account_code = 'b6f5783';
  $billing_info->first_name = 'Verena';
  $billing_info->last_name = 'Example';
  $billing_info->number = '4111-1111-1111-1111';
  $billing_info->verification_value = '123';
  $billing_info->month = 11;
  $billing_info->year = 2017;
  $billing_info->update();

  print "Billing Info: $billing_info";
} catch (Recurly_ValidationError $e) {
  // The data or card are invalid
  print "Invalid data or card: $e";
} catch (Recurly_NotFoundError $e) {
  // Could not find account
  print "Not Found: $e";
}
account = Recurly::Account.find('1')
account.billing_info = {
  :first_name         => 'Verena',
  :last_name          => 'Example',
  :number             => '4111-1111-1111-1111',
  :verification_value => '123',
  :month              => 11,
  :year               => 2015
}
account.billing_info.save!
account = Account.get('1')
billing_info = account.billing_info
billing_info.first_name = 'Verena'
billing_info.last_name = 'Example'
billing_info.number = '4111-1111-1111-1111'
billing_info.verification_value = '123'
billing_info.month = 11
billing_info.year = 2015
account.update_billing_info(billing_info)
var account = Accounts.Get("1");
var info = new BillingInfo(account);
info.FirstName = "Verana";
info.LastName = "Example";
info.CreditCardNumber = "4111-111-1111-1111";
info.VerificationValue = "123";
info.ExpirationMonth = 11;
info.ExpirationYear = 2015;
info.Update();
<billing_info>
  <first_name>Verena</first_name>
  <last_name>Example</last_name>
  <number>4111-1111-1111-1111</number>
  <verification_value>123</verification_value>
  <month>11</month>
  <year>2019</year>
  <ip_address>127.0.0.1</ip_address>
</billing_info>

Result Format

<billing_info href="https://your-subdomain.recurly.com/v2/accounts/1/billing_info" type="credit_card">
  <account href="https://your-subdomain.recurly.com/v2/accounts/1"/>
  <first_name>Verena</first_name>
  <last_name>Example</last_name>
  <company nil="nil"/>
  <address1>123 Main St.</address1>
  <address2 nil="nil"/>
  <city>San Francisco</city>
  <state>CA</state>
  <zip>94105</zip>
  <country>US</country>
  <phone nil="nil"/>
  <vat_number nil="nil"/>
  <ip_address>127.0.0.1</ip_address>
  <ip_address_country nil="nil"/>
  <card_type>Visa</card_type>
  <year type="integer">2019</year>
  <month type="integer">11</month>
  <first_six>411111</first_six>
  <last_four>1111</last_four>
</billing_info>


{"__v":0,"_id":"578e7c5ab434c30e0035bf79","api":{"examples":{"codes":[{"name":"","code":"<?php\n\ntry {\n  $billing_info = new Recurly_BillingInfo();\n  $billing_info->account_code = 'b6f5783';\n  $billing_info->name_on_account = 'Acme Inc.';\n  $billing_info->routing_number = '065400137';\n  $billing_info->account_number = '4444000000005555';\n  $billing_info->account_type = 'checking';\n  $billing_info->address1 = '123 Main St.';\n  $billing_info->city = 'San Francisco';\n  $billing_info->state ='CA';\n  $billing_info->country = 'US';\n  $billing_info->zip = '94105';\n  $billing_info->update();\n\n  print \"Billing Info: $billing_info\";\n} catch (Recurly_ValidationError $e) {\n  // The data or bank account are invalid\n  print \"Invalid data or card: $e\";\n} catch (Recurly_NotFoundError $e) {\n  // Could not find account\n  print \"Account Not Found: $e\";\n}","language":"php"},{"code":"account = Recurly::Account.find('1')\naccount.billing_info = {\n  name_on_account: 'Acme, Inc.',\n  routing_number: '065400137',\n  account_number: '4444000000005555',\n  address1: '123 Main St.',\n  city: 'San Francisco',\n  state: 'CA',\n  country: 'US',\n  zip: '94105'\n}\naccount.billing_info.save!","language":"ruby"},{"code":"account = Account.get('1')\nbilling_info = account.billing_info\nbilling_info.name_on_account = 'Acme, Inc.'\nbilling_info.routing_number = '065400137'\nbilling_info.account_number = '4444000000005555'\nbilling_info.account_type = 'checking'\nbilling_info.address1 = '123 Main St.'\nbilling_info.city = 'San Francisco'\nbilling_info.state ='CA'\nbilling_info.country = 'US'\nbilling_info.zip = '94105'\naccount.update_billing_info(billing_info)","language":"python"},{"code":"var account = Accounts.Get(\"1\");\nvar info = account.BillingInfo;\ninfo.NameOnAccount = \"Acme, Inc.\";\ninfo.RoutingNumber = \"065400137\";\ninfo.AccountNumber = \"4444000000005555\";\ninfo.AccountType = BillingInfo.BankAccountType.Checking;\ninfo.Address1 = \"123 Main St.\";\ninfo.City = \"San Francisco\";\ninfo.State = \"CA\";\ninfo.Country = \"US\";\ninfo.PostalCode = \"94105\";\ninfo.Update();","language":"csharp"},{"code":"<billing_info>\n  <name_on_account>Acme, Inc.</name_on_account>\n  <address1>123 Main St.</address1>\n  <address2 nil=\"nil\"></address2>\n  <city>San Francisco</city>\n  <state>CA</state>\n  <zip>94105</zip>\n  <country>US</country>\n  <routing_number>065400137</routing_number>\n  <account_number>4444000000005555</account_number>\n  <account_type>checking</account_type>\n  <ip_address>127.0.0.1</ip_address>\n</billing_info>","language":"xml"}]},"results":{"codes":[{"status":200,"language":"xml","code":"<billing_info href=\"https://your-subdomain.recurly.com/v2/accounts/1/billing_info\" type=\"bank_account\">\n  <account href=\"https://your-subdomain.recurly.com/v2/accounts/1\"/>\n  <name_on_account>Acme, Inc.</name_on_account>\n  <first_name nil=\"nil\"></first_name>\n  <last_name nil=\"nil\"></last_name>\n  <company nil=\"nil\"></company>\n  <address1>123 Main St.</address1>\n  <address2 nil=\"nil\"></address2>\n  <city>San Francisco</city>\n  <state>CA</state>\n  <zip>94105</zip>\n  <country>US</country>\n  <phone></phone>\n  <vat_number></vat_number>\n  <ip_address>127.0.0.1</ip_address>\n  <ip_address_country>US</ip_address_country>\n  <account_type>checking</account_type>\n  <last_four>5555</last_four>\n  <routing_number>065400137</routing_number>\n</billing_info>","name":""}]},"settings":"","auth":"required","params":[{"_id":"55944ff05c9eaa2300a86341","ref":"","in":"path","required":true,"desc":"Account's unique code.","default":"","type":"string","name":"account_code"},{"_id":"5581dafd8625220d00429ea7","ref":"","in":"body","required":true,"desc":"The name associated with the account. This may be a person's full name or a business name. This field must be 1 to 50 characters and can include: letters digits space . ' & , -","default":"","type":"string","name":"name_on_account"},{"_id":"5581dafd8625220d00429e9d","ref":"","in":"body","required":true,"desc":"Must be a real U.S. bank account routing number. All routing numbers are 9 digits.","default":"","type":"int","name":"routing_number"},{"_id":"5581dafd8625220d00429e9c","ref":"","in":"body","required":true,"desc":"Bank account number between 4 and 17 digits. We do not validate this number until the first transaction, so we recommend you have the customer confirm their account number.","default":"","type":"int","name":"account_number"},{"_id":"5581dafd8625220d00429e9b","ref":"","in":"body","required":true,"desc":"Either 'checking' or 'savings'","default":"","type":"int","name":"account_type"},{"_id":"5581dafd8625220d00429ea6","ref":"","in":"body","required":false,"desc":"Address line 1, recommended for address validation. This field has a 50 character max and can include: letters digits space . # / , -","default":"","type":"string","name":"address1"},{"_id":"5581dafd8625220d00429ea5","ref":"","in":"body","required":false,"desc":"Address line 2, this field has a 50 character max and can include: letters digits space . # / , -","default":"","type":"string","name":"address2"},{"_id":"5581dafd8625220d00429ea4","ref":"","in":"body","required":false,"desc":"City, this field has a 50 character max and can include: letters digits space . , -","default":"","type":"string","name":"city"},{"_id":"5581dafd8625220d00429ea3","ref":"","in":"body","required":false,"desc":"State, this field has a 2 character max and can be lowercase or uppercase.","default":"","type":"string","name":"state"},{"_id":"5581dafd8625220d00429ea2","ref":"","in":"body","required":false,"desc":"Country, [2-letter ISO code](http://www.iso.org/iso/country_names_and_code_elements). **STRONGLY RECOMMENDED**","default":"","type":"string","name":"country"},{"_id":"5581dafd8625220d00429ea1","ref":"","in":"body","required":false,"desc":"Zip or postal code, recommended for address validation. This field can be just 5 digits or can have an optional additional 4 digits separated by a hyphen (e.g. 12345-6789).","default":"","type":"string","name":"zip"},{"_id":"5581dafd8625220d00429ea0","ref":"","in":"body","required":false,"desc":"Phone number, this field can be 10 digits.","default":"","type":"string","name":"phone"},{"_id":"5581dafd8625220d00429e9f","ref":"","in":"body","required":false,"desc":"Customer's VAT Number","default":"","type":"string","name":"vat_number"},{"_id":"5581dafd8625220d00429e9e","ref":"","in":"body","required":false,"desc":"Customer's IP address when updating their Billing Information **STRONGLY RECOMMENDED**","default":"","type":"string","name":"ip_address"}],"url":"/accounts/:account_code/billing_info"},"body":"Instead of using a token generated by Recurly.js, you can instead submit full bank account and address information when updating Billing Information.\n\nWhen Billing Information is updated, it is only saved if the required fields are provided and they meet the field validation requirements. If the account has a past due invoice, the outstanding balance will be collected when the Billing Information is updated.\n\nIf you want to create an account at the same time, you should use the [Account API end-point](https://docs.recurly.com/api/accounts#create-account) instead and include Billing Information with your request.\n\nIf you need to set a back dated subscription authorization date for the NACHA three year re-authorization rule, do so on the Create Subscription call using the \"bank_account_authorized_at\" attribute.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Recurly strongly recommends using a token [generated by Recurly.js](https://docs.recurly.com/js/#getting-a-token) rather than directly handling your customer's bank account details. You can, however, use this API call to update the billing address associated with an account.\",\n  \"title\": \"Please note\"\n}\n[/block]","category":"578e7c59b434c30e0035bf2c","createdAt":"2015-06-17T20:39:25.270Z","excerpt":"Returns the account's updated Billing Information. You will need to have the ACH feature on your site for this call to work.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":7,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"update-an-accounts-billing-info-bank-account","sync_unique":"","title":"Update Account's Billing Info (Bank Account)","type":"put","updates":["55d336d80168850d0073f056","55d33926f77e6d0d00b1afb5"],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

putUpdate Account's Billing Info (Bank Account)

Returns the account's updated Billing Information. You will need to have the ACH feature on your site for this call to work.

account_code:
required
string
Account's unique code.
name_on_account:
required
string
The name associated with the account. This may be a person's full name or a business name. This field must be 1 to 50 characters and can include: letters digits space . ' & , -
routing_number:
required
integer
Must be a real U.S. bank account routing number. All routing numbers are 9 digits.
account_number:
required
integer
Bank account number between 4 and 17 digits. We do not validate this number until the first transaction, so we recommend you have the customer confirm their account number.
account_type:
required
integer
Either 'checking' or 'savings'
address1:
string
Address line 1, recommended for address validation. This field has a 50 character max and can include: letters digits space . # / , -
address2:
string
Address line 2, this field has a 50 character max and can include: letters digits space . # / , -
city:
string
City, this field has a 50 character max and can include: letters digits space . , -
state:
string
State, this field has a 2 character max and can be lowercase or uppercase.
country:
string
Country, [2-letter ISO code](http://www.iso.org/iso/country_names_and_code_elements). **STRONGLY RECOMMENDED**
zip:
string
Zip or postal code, recommended for address validation. This field can be just 5 digits or can have an optional additional 4 digits separated by a hyphen (e.g. 12345-6789).
phone:
string
Phone number, this field can be 10 digits.
vat_number:
string
Customer's VAT Number
ip_address:
string
Customer's IP address when updating their Billing Information **STRONGLY RECOMMENDED**

Instead of using a token generated by Recurly.js, you can instead submit full bank account and address information when updating Billing Information.

When Billing Information is updated, it is only saved if the required fields are provided and they meet the field validation requirements. If the account has a past due invoice, the outstanding balance will be collected when the Billing Information is updated.

If you want to create an account at the same time, you should use the Account API end-point instead and include Billing Information with your request.

If you need to set a back dated subscription authorization date for the NACHA three year re-authorization rule, do so on the Create Subscription call using the "bank_account_authorized_at" attribute.

Please note

Recurly strongly recommends using a token generated by Recurly.js rather than directly handling your customer's bank account details. You can, however, use this API call to update the billing address associated with an account.

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php

try {
  $billing_info = new Recurly_BillingInfo();
  $billing_info->account_code = 'b6f5783';
  $billing_info->name_on_account = 'Acme Inc.';
  $billing_info->routing_number = '065400137';
  $billing_info->account_number = '4444000000005555';
  $billing_info->account_type = 'checking';
  $billing_info->address1 = '123 Main St.';
  $billing_info->city = 'San Francisco';
  $billing_info->state ='CA';
  $billing_info->country = 'US';
  $billing_info->zip = '94105';
  $billing_info->update();

  print "Billing Info: $billing_info";
} catch (Recurly_ValidationError $e) {
  // The data or bank account are invalid
  print "Invalid data or card: $e";
} catch (Recurly_NotFoundError $e) {
  // Could not find account
  print "Account Not Found: $e";
}
account = Recurly::Account.find('1')
account.billing_info = {
  name_on_account: 'Acme, Inc.',
  routing_number: '065400137',
  account_number: '4444000000005555',
  address1: '123 Main St.',
  city: 'San Francisco',
  state: 'CA',
  country: 'US',
  zip: '94105'
}
account.billing_info.save!
account = Account.get('1')
billing_info = account.billing_info
billing_info.name_on_account = 'Acme, Inc.'
billing_info.routing_number = '065400137'
billing_info.account_number = '4444000000005555'
billing_info.account_type = 'checking'
billing_info.address1 = '123 Main St.'
billing_info.city = 'San Francisco'
billing_info.state ='CA'
billing_info.country = 'US'
billing_info.zip = '94105'
account.update_billing_info(billing_info)
var account = Accounts.Get("1");
var info = account.BillingInfo;
info.NameOnAccount = "Acme, Inc.";
info.RoutingNumber = "065400137";
info.AccountNumber = "4444000000005555";
info.AccountType = BillingInfo.BankAccountType.Checking;
info.Address1 = "123 Main St.";
info.City = "San Francisco";
info.State = "CA";
info.Country = "US";
info.PostalCode = "94105";
info.Update();
<billing_info>
  <name_on_account>Acme, Inc.</name_on_account>
  <address1>123 Main St.</address1>
  <address2 nil="nil"></address2>
  <city>San Francisco</city>
  <state>CA</state>
  <zip>94105</zip>
  <country>US</country>
  <routing_number>065400137</routing_number>
  <account_number>4444000000005555</account_number>
  <account_type>checking</account_type>
  <ip_address>127.0.0.1</ip_address>
</billing_info>

Result Format

<billing_info href="https://your-subdomain.recurly.com/v2/accounts/1/billing_info" type="bank_account">
  <account href="https://your-subdomain.recurly.com/v2/accounts/1"/>
  <name_on_account>Acme, Inc.</name_on_account>
  <first_name nil="nil"></first_name>
  <last_name nil="nil"></last_name>
  <company nil="nil"></company>
  <address1>123 Main St.</address1>
  <address2 nil="nil"></address2>
  <city>San Francisco</city>
  <state>CA</state>
  <zip>94105</zip>
  <country>US</country>
  <phone></phone>
  <vat_number></vat_number>
  <ip_address>127.0.0.1</ip_address>
  <ip_address_country>US</ip_address_country>
  <account_type>checking</account_type>
  <last_four>5555</last_four>
  <routing_number>065400137</routing_number>
</billing_info>


{"__v":0,"_id":"578e7c5ab434c30e0035bf7a","api":{"examples":{"codes":[{"name":"","code":"<?php\n\ntry {\n  $billing_info = new Recurly_BillingInfo();\n  $billing_info->account_code = 'b6f5783';\n  $billing_info->first_name = 'Verena';\n  $billing_info->last_name = 'Example';\n  $billing_info->paypal_billing_agreement_id = 'BA-0HS87238YB688345C';\n  $billing_info->create();\n\n  print \"Billing Info: $billing_info\";\n} catch (Recurly_ValidationError $e) {\n  // The paypal billing agreement provided is invalid\n  print \"Invalid paypal billing agreement: $e\";\n} catch (Recurly_NotFoundError $e) {\n  // Could not find account\n  print \"Not Found: $e\";\n}","language":"php"},{"code":"account = Recurly::Account.find('1')\naccount.billing_info = {\n  :first_name         => 'Verena',\n  :last_name          => 'Example',\n  :paypal_billing_agreement_id             => 'BA-0HS87238YB688345C'\n}\naccount.billing_info.save!","language":"ruby"},{"code":"account = Account.get('1')\nbilling_info = account.billing_info\nbilling_info.first_name = 'Verena'\nbilling_info.last_name = 'Example'\nbilling_info.paypal_billing_agreement_id = 'BA-0HS87238YB688345C'\naccount.update_billing_info(billing_info)","language":"python"},{"code":"var account = Accounts.Get(\"1\");\nvar info = new BillingInfo(account);\ninfo.FirstName = \"Verana\";\ninfo.LastName = \"Example\";\ninfo.PaypalBillingAgreementId = \"BA-0HS87238YB688345C\";\ninfo.Create();","language":"csharp"},{"code":"<billing_info>\n  <first_name>Verena</first_name>\n  <last_name>Example</last_name>\n  <address1>123 Main St.</address1>\n  <address2 nil=\"nil\"></address2>\n  <city>San Francisco</city>\n  <state>CA</state>\n  <zip>94105</zip>\n  <country>US</country>\n  <paypal_billing_agreement_id>BA-0HS87238YB688345C</paypal_billing_agreement_id>\n  <ip_address>127.0.0.1</ip_address>\n</billing_info>","language":"xml"}]},"results":{"codes":[{"name":"","code":"<billing_info href=\"https://your-subdomain.recurly.com/v2/accounts/1/billing_info\" type=\"credit_card\">\n  <account href=\"https://your-subdomain.recurly.com/v2/accounts/1\"/>\n  <first_name>Verena</first_name>\n  <last_name>Example</last_name>\n  <company nil=\"nil\"></company>\n  <address1>123 Main St.</address1>\n  <address2 nil=\"nil\"></address2>\n  <city>San Francisco</city>\n  <state>CA</state>\n  <zip>94105</zip>\n  <country>US</country>\n  <phone nil=\"nil\"></phone>\n  <paypal_billing_agreement_id>BA-0HS87238YB688345C</paypal_billing_agreement_id>\n</billing_info>","language":"xml","status":201}]},"settings":"","auth":"required","params":[{"_id":"55944fab5c9eaa2300a8633c","ref":"","in":"path","required":true,"desc":"Account's unique code.","default":"","type":"string","name":"account_code"},{"_id":"5581d09a8625220d00429e4d","ref":"","in":"body","required":true,"desc":"First name","default":"","type":"string","name":"first_name"},{"_id":"5581d09a8625220d00429e4c","ref":"","in":"body","required":true,"desc":"Last name","default":"","type":"string","name":"last_name"},{"_id":"5581d09a8625220d00429e4b","ref":"","in":"body","required":false,"desc":"Address line 1, recommended for address validation","default":"","type":"string","name":"address1"},{"_id":"5581d09a8625220d00429e4a","ref":"","in":"body","required":false,"desc":"Address line 2.","default":"","type":"string","name":"address2"},{"_id":"5581d09a8625220d00429e49","ref":"","in":"body","required":false,"desc":"City","default":"","type":"string","name":"city"},{"_id":"5581d09a8625220d00429e48","ref":"","in":"body","required":false,"desc":"State","default":"","type":"string","name":"state"},{"_id":"5581d09a8625220d00429e47","ref":"","in":"body","required":false,"desc":"Country, [2-letter ISO code](http://www.iso.org/iso/country_names_and_code_elements) **STRONGLY RECOMMENDED**","default":"","type":"string","name":"country"},{"_id":"5581d09a8625220d00429e46","ref":"","in":"body","required":false,"desc":"Zip or postal code, recommended for address validation","default":"","type":"string","name":"zip"},{"_id":"5581d09a8625220d00429e45","ref":"","in":"body","required":false,"desc":"Phone number","default":"","type":"string","name":"phone"},{"_id":"5723d8f2110e570e00486c2f","ref":"","in":"body","required":false,"desc":"Paypal's billing agreement","default":"","type":"string","name":"paypal_billing_agreement_id"},{"_id":"5581d09a8625220d00429e44","ref":"","in":"body","required":false,"desc":"Customer's VAT Number","default":"","type":"string","name":"vat_number"},{"_id":"56c3c1ce70187b17005f4395","ref":"","in":"body","required":false,"desc":"Currency in which invoices will be posted. Only applicable if this account is enrolled in a plan has a different currency than your site's default.","default":"","type":"string","name":"currency"},{"_id":"5581d09a8625220d00429e43","ref":"","in":"body","required":false,"desc":"Customer's IP address when updating their Billing Information **STRONGLY RECOMMENDED**","default":"","type":"string","name":"ip_address"}],"url":"/accounts/:account_code/billing_info"},"body":"Instead of using a token generated by Recurly.js, you can instead submit full credit card and address information when creating Billing Information.\n\nWhen Billing Information is submitted, it is only saved if valid. If the account has a past due invoice, the outstanding balance will be collected to validate the Billing Information.\n\nIf you want to create an account at the same time, you should use the [Account API end-point](https://docs.recurly.com/api/accounts#create-account) instead and include Billing Information with your request.\n\nThe required address fields will correspond to the **address requirements** configured for your site.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Recurly strongly recommends using a token [generated by Recurly.js](https://docs.recurly.com/js/#getting-a-token) rather than directly handling your customer's credit card details.\",\n  \"title\": \"Please note\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"This API end-point may be used to import Billing Information without security codes (CVV). Recurly recommends requiring CVV from your customers when collecting new or updated Billing Information.\",\n  \"title\": \"Please note\"\n}\n[/block]","category":"578e7c59b434c30e0035bf2c","createdAt":"2016-04-29T21:59:52.047Z","excerpt":"Updates the account's Billing Information using external token for example: Paypal billing agreement","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":8,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"update-an-accounts-billing-info-using-external-token","sync_unique":"","title":"Update Account's Billing Info (using external token)","type":"put","updates":[],"user":"56c3c01334df460d00c2beb3","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

putUpdate Account's Billing Info (using external token)

Updates the account's Billing Information using external token for example: Paypal billing agreement

account_code:
required
string
Account's unique code.
first_name:
required
string
First name
last_name:
required
string
Last name
address1:
string
Address line 1, recommended for address validation
address2:
string
Address line 2.
city:
string
City
state:
string
State
country:
string
Country, [2-letter ISO code](http://www.iso.org/iso/country_names_and_code_elements) **STRONGLY RECOMMENDED**
zip:
string
Zip or postal code, recommended for address validation
phone:
string
Phone number
paypal_billing_agreement_id:
string
Paypal's billing agreement
vat_number:
string
Customer's VAT Number
currency:
string
Currency in which invoices will be posted. Only applicable if this account is enrolled in a plan has a different currency than your site's default.
ip_address:
string
Customer's IP address when updating their Billing Information **STRONGLY RECOMMENDED**

Instead of using a token generated by Recurly.js, you can instead submit full credit card and address information when creating Billing Information.

When Billing Information is submitted, it is only saved if valid. If the account has a past due invoice, the outstanding balance will be collected to validate the Billing Information.

If you want to create an account at the same time, you should use the Account API end-point instead and include Billing Information with your request.

The required address fields will correspond to the address requirements configured for your site.

Please note

Recurly strongly recommends using a token generated by Recurly.js rather than directly handling your customer's credit card details.

Please note

This API end-point may be used to import Billing Information without security codes (CVV). Recurly recommends requiring CVV from your customers when collecting new or updated Billing Information.

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php

try {
  $billing_info = new Recurly_BillingInfo();
  $billing_info->account_code = 'b6f5783';
  $billing_info->first_name = 'Verena';
  $billing_info->last_name = 'Example';
  $billing_info->paypal_billing_agreement_id = 'BA-0HS87238YB688345C';
  $billing_info->create();

  print "Billing Info: $billing_info";
} catch (Recurly_ValidationError $e) {
  // The paypal billing agreement provided is invalid
  print "Invalid paypal billing agreement: $e";
} catch (Recurly_NotFoundError $e) {
  // Could not find account
  print "Not Found: $e";
}
account = Recurly::Account.find('1')
account.billing_info = {
  :first_name         => 'Verena',
  :last_name          => 'Example',
  :paypal_billing_agreement_id             => 'BA-0HS87238YB688345C'
}
account.billing_info.save!
account = Account.get('1')
billing_info = account.billing_info
billing_info.first_name = 'Verena'
billing_info.last_name = 'Example'
billing_info.paypal_billing_agreement_id = 'BA-0HS87238YB688345C'
account.update_billing_info(billing_info)
var account = Accounts.Get("1");
var info = new BillingInfo(account);
info.FirstName = "Verana";
info.LastName = "Example";
info.PaypalBillingAgreementId = "BA-0HS87238YB688345C";
info.Create();
<billing_info>
  <first_name>Verena</first_name>
  <last_name>Example</last_name>
  <address1>123 Main St.</address1>
  <address2 nil="nil"></address2>
  <city>San Francisco</city>
  <state>CA</state>
  <zip>94105</zip>
  <country>US</country>
  <paypal_billing_agreement_id>BA-0HS87238YB688345C</paypal_billing_agreement_id>
  <ip_address>127.0.0.1</ip_address>
</billing_info>

Result Format

<billing_info href="https://your-subdomain.recurly.com/v2/accounts/1/billing_info" type="credit_card">
  <account href="https://your-subdomain.recurly.com/v2/accounts/1"/>
  <first_name>Verena</first_name>
  <last_name>Example</last_name>
  <company nil="nil"></company>
  <address1>123 Main St.</address1>
  <address2 nil="nil"></address2>
  <city>San Francisco</city>
  <state>CA</state>
  <zip>94105</zip>
  <country>US</country>
  <phone nil="nil"></phone>
  <paypal_billing_agreement_id>BA-0HS87238YB688345C</paypal_billing_agreement_id>
</billing_info>


{"__v":0,"_id":"578e7c5ab434c30e0035bf7b","api":{"examples":{"codes":[{"name":"","code":"<?php\n\ntry {\n  $billing_info = Recurly_BillingInfo::get('b6f5783');\n  $billing_info->delete();\n\n  // Or, in a single API request:\n  // Recurly_BillingInfo::deleteForAccount('b6f5783');\n\n  print \"Billing Info: $billing_info\";\n} catch (Recurly_NotFoundError $e) {\n  // Account not found or account does not have billing info\n  print \"Not Found: $e\";\n}","language":"php"},{"code":"account = Recurly::Account.find('1')\nif billing_info = account.billing_info\n  billing_info.destroy\nend","language":"ruby"},{"code":"account = Account.get('1')\nbilling_info = account.billing_info\nif billing_info\n  billing_info.delete()","language":"python"},{"code":"var account = Accounts.Get(\"1\");\naccount.DeleteBillingInfo();","language":"csharp"}]},"results":{"codes":[{"name":"","code":"Status: 204 No Content","language":"json","status":204}]},"settings":"","auth":"required","params":[{"_id":"55944ffb0c33bd0d0005964c","ref":"","in":"path","required":true,"desc":"Account's unique code.","default":"","type":"string","name":"account_code"}],"url":"/accounts/:account_code/billing_info"},"body":"","category":"578e7c59b434c30e0035bf2c","createdAt":"2015-06-17T20:40:02.831Z","excerpt":"You may remove any stored billing information for an account. If the account has a subscription, the renewal will go into past due unless you update the billing info before the renewal occurs.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":9,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"clear-an-accounts-billing-info","sync_unique":"","title":"Clear Account's Billing Info","type":"delete","updates":[],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

deleteClear Account's Billing Info

You may remove any stored billing information for an account. If the account has a subscription, the renewal will go into past due unless you update the billing info before the renewal occurs.

account_code:
required
string
Account's unique code.

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php

try {
  $billing_info = Recurly_BillingInfo::get('b6f5783');
  $billing_info->delete();

  // Or, in a single API request:
  // Recurly_BillingInfo::deleteForAccount('b6f5783');

  print "Billing Info: $billing_info";
} catch (Recurly_NotFoundError $e) {
  // Account not found or account does not have billing info
  print "Not Found: $e";
}
account = Recurly::Account.find('1')
if billing_info = account.billing_info
  billing_info.destroy
end
account = Account.get('1')
billing_info = account.billing_info
if billing_info
  billing_info.delete()
var account = Accounts.Get("1");
account.DeleteBillingInfo();

Result Format

Status: 204 No Content


{"__v":4,"_id":"578e7c5ab434c30e0035bf96","api":{"auth":"required","examples":{"codes":[{"name":"","code":"<?php\n\n$coupons = Recurly_CouponList::get();\nforeach ($coupons as $coupon) {\n  print \"Coupon: $coupon\\n\";\n}","language":"php"},{"code":"Recurly::Coupon.find_each do |coupon|\n  puts \"Coupon: #{coupon.inspect}\"\nend","language":"ruby"},{"code":"#client version 2.1.6+\nfor coupon in Coupon.all():\n    print 'Coupon: %s' % coupon\n\n#client version <= 2.1.5\ncoupons = Coupon.all()\nwhile coupons:\n    for coupon in coupons:\n        print 'Coupon: %s' % coupon\n    try:\n        coupons = coupons.next_page()\n    except PageError:\n        coupons = ()\n","language":"python"},{"code":"using System.Linq;\n\nvar coupons = Coupons.List();\nwhile (coupons.Any())\n{\n\tforeach (var coupon in coupons)\n\t\tConsole.WriteLine(\"Coupon: \" + coupon);\n\tcoupons = coupons.Next;\n}","language":"csharp"}]},"params":[{"_id":"5581f3c38625220d00429ee7","ref":"","in":"query","required":false,"desc":"The state of coupons to return: `redeemable`, `expired`, `maxed_out`, or `inactive`.","default":"all","type":"string","name":"state"},{"_id":"578eaf697d6eeb0e004fb85e","ref":"","in":"query","required":false,"desc":"The attribute that will be used to order records: `created_at`, `updated_at`.","default":"created_at","type":"string","name":"sort"},{"_id":"578eaf697d6eeb0e004fb85d","ref":"","in":"query","required":false,"desc":"The order in which products will be returned: `asc` for ascending order, `desc` for descending order.","default":"desc","type":"string","name":"order"},{"_id":"578eaf85902f512200bd3f9f","ref":"","in":"query","required":false,"desc":"Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes greater than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.","default":"","type":"datetime","name":"begin_time"},{"_id":"578eafa27d6eeb0e004fb85f","ref":"","in":"query","required":false,"desc":"Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes less than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.","default":"","type":"datetime","name":"end_time"},{"_id":"5581f3c38625220d00429ee5","ref":"","in":"query","required":false,"desc":"Number of records to return per page, up to a maximum of 200.","default":"50","type":"int","name":"per_page"},{"_id":"5581f3c38625220d00429ee6","ref":"","in":"query","required":false,"desc":"Splits records across pages. Leave blank to return the first page. Follow the URI in the first page's Link header to fetch the next page.","default":"","type":"string","name":"cursor"}],"results":{"codes":[{"name":"","code":"<coupons type=\"array\">\n  <coupon href=\"https://your-subdomain.recurly.com/v2/coupons/special\">\n    <redemptions href=\"https://your-subdomain.recurly.com/v2/coupons/special/redemptions\"/>\n    <coupon_code>special</coupon_code>\n    <name>Special 10% off</name>\n    <state>redeemable</state>\n    <description nil=\"nil\"/>\n    <discount_type>percent</discount_type>\n    <discount_percent type=\"integer\">10</discount_percent>\n    <invoice_description nil=\"nil\"/>\n    <redeem_by_date type=\"datetime\">2017-12-31T00:00:00Z</redeem_by_date>\n    <single_use type=\"boolean\">true</single_use>\n    <applies_for_months nil=\"nil\"/>\n    <max_redemptions type=\"integer\">200</max_redemptions>\n    <applies_to_all_plans type=\"boolean\">false</applies_to_all_plans>\n    <created_at type=\"datetime\">2016-07-11T18:50:17Z</created_at>\n    <updated_at type=\"datetime\">2016-07-11T18:50:17Z</updated_at>\n    <deleted_at nil=\"nil\"/>\n    <duration>single_use</duration>\n    <temporal_unit nil=\"nil\"/>\n    <temporal_amount nil=\"nil\"/>\n    <applies_to_non_plan_charges type=\"boolean\">false</applies_to_non_plan_charges>\n    <redemption_resource>account</redemption_resource>\n    <max_redemptions_per_account nil=\"nil\"/>\n    <coupon_type>single_code</coupon_type>\n    <plan_codes type=\"array\">\n      <plan_code>gold</plan_code>\n      <plan_code>platinum</plan_code>\n    </plan_codes>\n    <a name=\"redeem\" href=\"https://your-subdomain.recurly.com/v2/coupons/special/redeem\" method=\"post\"/>\n  </coupon>\n  <!-- Continued... -->\n</coupons>","language":"xml","status":200}]},"settings":"","url":"/coupons"},"body":"","category":"578e7c59b434c30e0035bf2d","createdAt":"2015-06-17T22:25:07.292Z","excerpt":"Returns a list of all the coupons.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"list-active-coupons","sync_unique":"","title":"List Coupons","type":"get","updates":[],"user":"55648cf93b87582b003ab8b1","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

getList Coupons

Returns a list of all the coupons.

state:
stringall
The state of coupons to return: `redeemable`, `expired`, `maxed_out`, or `inactive`.
sort:
stringcreated_at
The attribute that will be used to order records: `created_at`, `updated_at`.
order:
stringdesc
The order in which products will be returned: `asc` for ascending order, `desc` for descending order.
begin_time:
datetime
Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes greater than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.
end_time:
datetime
Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes less than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.
per_page:
integer50
Number of records to return per page, up to a maximum of 200.
cursor:
string
Splits records across pages. Leave blank to return the first page. Follow the URI in the first page's Link header to fetch the next page.

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php

$coupons = Recurly_CouponList::get();
foreach ($coupons as $coupon) {
  print "Coupon: $coupon\n";
}
Recurly::Coupon.find_each do |coupon|
  puts "Coupon: #{coupon.inspect}"
end
#client version 2.1.6+
for coupon in Coupon.all():
    print 'Coupon: %s' % coupon

#client version <= 2.1.5
coupons = Coupon.all()
while coupons:
    for coupon in coupons:
        print 'Coupon: %s' % coupon
    try:
        coupons = coupons.next_page()
    except PageError:
        coupons = ()
using System.Linq;

var coupons = Coupons.List();
while (coupons.Any())
{
	foreach (var coupon in coupons)
		Console.WriteLine("Coupon: " + coupon);
	coupons = coupons.Next;
}

Result Format

<coupons type="array">
  <coupon href="https://your-subdomain.recurly.com/v2/coupons/special">
    <redemptions href="https://your-subdomain.recurly.com/v2/coupons/special/redemptions"/>
    <coupon_code>special</coupon_code>
    <name>Special 10% off</name>
    <state>redeemable</state>
    <description nil="nil"/>
    <discount_type>percent</discount_type>
    <discount_percent type="integer">10</discount_percent>
    <invoice_description nil="nil"/>
    <redeem_by_date type="datetime">2017-12-31T00:00:00Z</redeem_by_date>
    <single_use type="boolean">true</single_use>
    <applies_for_months nil="nil"/>
    <max_redemptions type="integer">200</max_redemptions>
    <applies_to_all_plans type="boolean">false</applies_to_all_plans>
    <created_at type="datetime">2016-07-11T18:50:17Z</created_at>
    <updated_at type="datetime">2016-07-11T18:50:17Z</updated_at>
    <deleted_at nil="nil"/>
    <duration>single_use</duration>
    <temporal_unit nil="nil"/>
    <temporal_amount nil="nil"/>
    <applies_to_non_plan_charges type="boolean">false</applies_to_non_plan_charges>
    <redemption_resource>account</redemption_resource>
    <max_redemptions_per_account nil="nil"/>
    <coupon_type>single_code</coupon_type>
    <plan_codes type="array">
      <plan_code>gold</plan_code>
      <plan_code>platinum</plan_code>
    </plan_codes>
    <a name="redeem" href="https://your-subdomain.recurly.com/v2/coupons/special/redeem" method="post"/>
  </coupon>
  <!-- Continued... -->
</coupons>


{"__v":0,"_id":"578e7c5ab434c30e0035bf98","api":{"examples":{"codes":[{"language":"php","code":"<?php\n\ntry {\n  $coupon = new Recurly_Coupon();\n  $coupon->coupon_code = 'gorby1';\n  $coupon->redeem_by_date = '2016-07-04';\n  $coupon->duration = 'single_use';\n  $coupon->redemption_resource = 'subscription';\n  $coupon->max_redemptions_per_account = 1;\n  $coupon->applies_to_non_plan_charges = true;\n\n  // $2 off...\n  $coupon->name = 'Special $2 off coupon';\n  $coupon->discount_type = 'dollars';\n  $coupon->discount_in_cents->addCurrency('USD',200); // $2.00 discount\n\n  // ...or 10% off.\n  $coupon->name = 'Special 10% off';\n  $coupon->discount_type = 'percent';\n  $coupon->discount_percent = 10;\n\n  // Limit to gold and platinum plans only.\n  $coupon->applies_to_all_plans = false;\n  $coupon->plan_codes = array('gold', 'platinum');\n\n  $coupon->create();\n\n  print \"Coupon: $coupon\";\n} catch (Recurly_ValidationError $e) {\n  print \"Invalid data: $e\";\n}","name":""},{"language":"ruby","code":"coupon = Recurly::Coupon.new(\n  :coupon_code    => 'special',\n  :redeem_by_date => Date.new(2014, 1, 1),\n  :duration     => 'single_use'\n)\n\n# $2 off...\ncoupon.name = 'Special $2 off coupon'\ncoupon.discount_type = 'dollars'\ncoupon.discount_in_cents = 2_00\n\n# ...or 10% off.\ncoupon.name = 'Special 10% off'\ncoupon.discount_type = 'percent'\ncoupon.discount_percent = 10\n\n# Limit to gold and platinum plans only.\ncoupon.applies_to_all_plans = false\ncoupon.plan_codes = %w(gold platinum)\n\n# Limit redemption to specific subscription on account.\ncoupon.redemption_resource = 'subscription'\n\n# Limit redemptions per account to a specific number.\ncoupon.max_redemptions_per_account = 1\n\n# Discount should include one-time charges.\ncoupon.applies_to_non_plan_charges = true\n\ncoupon.save"},{"language":"python","code":"coupon = Coupon(\n  coupon_code='special',\n  redeem_by_date=datetime.date(2014, 1, 1),\n  duration='single_use'\n)\n\n# $2 off...\ncoupon.name = 'Special $2 off coupon'\ncoupon.discount_type = 'dollars'\ncoupon.discount_in_cents = Money(200)\n\n# ...or 10% off.\ncoupon.name = 'Special 10% off'\ncoupon.discount_type = 'percent'\ncoupon.discount_percent = 10\n\n# Limit to gold and platinum plans only.\ncoupon.applies_to_all_plans = False\ncoupon.plan_codes = ['gold', 'platinum']\n\n# Limit redemption to specific subscription on account.\ncoupon.redemption_resource = 'subscription'\n\n# Limit redemptions per account to a specific number.\ncoupon.max_redemptions_per_account = 1\n\n# Discount should include one-time charges.\ncoupon.applies_to_non_plan_charges = True\n\ncoupon.save()"},{"language":"csharp","code":"// new Coupon(<code>, <name>, <discount>)\n\n// $2 off...\nvar coupon = new Coupon(\"special\",\n        \"Special $2 off coupon\", new Dictionary<string, int>() { { \"USD\", 200 } });\n\n// ... or 10% off...\nvar coupon = new Coupon(\"special\",\n        \"Special 10% off coupon\", 10);\n\ncoupon.RedeemByDate = new DateTime(2017, 1, 1);\ncoupon.SingleUse = true;\n\n// Limit to gold and platinum plans only.\ncoupon.AppliesToAllPlans = false;\ncoupon.Plans.Add(\"gold\");\ncoupon.Plans.Add(\"silver\");\n\n// Other properties\ncoupon.RedeemByDate = new DateTime(2014, 1, 1);\ncoupon.SingleUse = true;\ncoupon.RedemptionResource = Coupon.RedemptionResourceType.Subscription;\ncoupon.MaxRedemptionsPerAccount = 1;\ncoupon.AppliesToNonPlanCharges = true;\n\ncoupon.Create();"},{"name":"","language":"xml","code":"<!-- For All Plans -->\n<coupon>\n  <coupon_code>special</coupon_code>\n  <name>Special $2 off coupon</name>\n  <discount_type>dollars</discount_type>\n    <discount_in_cents>\n    <USD>200</USD>\n  </discount_in_cents>\n  <redeem_by_date>2017-12-31</redeem_by_date>\n  <duration>temporal</duration>\n  <temporal_unit>day</temporal_unit>\n  <temporal_amount>28</temporal_amount>\n  <max_redemptions>200</max_redemptions>\n  <max_redemptions_per_account>1</max_redemptions_per_account>\n  <applies_to_all_plans>true</applies_to_all_plans>\n</coupon>\n\n<!-- For specific plan codes -->\n<coupon>\n  <coupon_code>subscription_special</coupon_code>\n  <name>Special 10% off</name>\n  <discount_type>percent</discount_type>\n  <discount_percent>10</discount_percent>\n  <redeem_by_date>2017-12-31</redeem_by_date>\n  <max_redemptions>200</max_redemptions>\n  <applies_to_all_plans>false</applies_to_all_plans>\n  <plan_codes>\n    <plan_code>gold</plan_code>\n    <plan_code>platinum</plan_code>\n  </plan_codes>\n  <redemption_resource>subscription</redemption_resource>\n</coupon>"}]},"results":{"codes":[{"status":201,"language":"xml","code":"<coupon href=\"https://your-subdomain.recurly.com/v2/coupons/special\">\n  <redemptions href=\"https://your-subdomain.recurly.com/v2/coupons/special/redemptions\"/>\n  <coupon_code>special</coupon_code>\n  <name>Special 10% off</name>\n  <state>redeemable</state>\n  <description nil=\"nil\"/>\n  <discount_type>percent</discount_type>\n  <discount_percent type=\"integer\">10</discount_percent>\n  <invoice_description nil=\"nil\"/>\n  <redeem_by_date type=\"datetime\">2017-12-31T00:00:00Z</redeem_by_date>\n  <single_use type=\"boolean\">true</single_use>\n  <applies_for_months nil=\"nil\"/>\n  <max_redemptions type=\"integer\">200</max_redemptions>\n  <applies_to_all_plans type=\"boolean\">false</applies_to_all_plans>\n  <created_at type=\"datetime\">2016-07-11T18:50:17Z</created_at>\n  <updated_at type=\"datetime\">2016-07-11T18:50:17Z</updated_at>\n  <deleted_at nil=\"nil\"/>\n  <duration>single_use</duration>\n  <temporal_unit nil=\"nil\"/>\n  <temporal_amount nil=\"nil\"/>\n  <applies_to_non_plan_charges type=\"boolean\">false</applies_to_non_plan_charges>\n  <redemption_resource>account</redemption_resource>\n  <max_redemptions_per_account nil=\"nil\"/>\n  <coupon_type>single_code</coupon_type>\n  <plan_codes type=\"array\">\n    <plan_code>gold</plan_code>\n    <plan_code>platinum</plan_code>\n  </plan_codes>\n  <a name=\"redeem\" href=\"https://your-subdomain.recurly.com/v2/coupons/special/redeem\" method=\"post\"/>\n</coupon>","name":""}]},"settings":"","auth":"required","params":[{"_id":"5581fc9c8625220d00429f13","ref":"","in":"body","required":true,"desc":"Unique code to identify and redeem the coupon. This code may only contain the following characters: [a-z A-Z 0-9 + - _ ]. Max of 50 characters.","default":"","type":"string","name":"coupon_code"},{"_id":"5581fc9c8625220d00429f12","ref":"","in":"body","required":true,"desc":"Coupon name.","default":"","type":"string","name":"name"},{"_id":"5581fc9c8625220d00429f11","ref":"","in":"body","required":false,"desc":"Description of the coupon on the hosted payment pages.","default":"","type":"string","name":"description"},{"_id":"5581fc9c8625220d00429f0a","ref":"","in":"body","required":true,"desc":"`percent` or `dollars`.","default":"","type":"string","name":"discount_type"},{"_id":"5581fc9c8625220d00429f08","ref":"","in":"body","required":false,"desc":"Mapping of discount amounts by currency if discount_type is `dollars`. Max 10000000.","default":"","type":"int","name":"discount_in_cents"},{"_id":"5581fc9c8625220d00429f09","ref":"","in":"body","required":false,"desc":"Discount percentage if discount_type is `percent`.","default":"","type":"int","name":"discount_percent"},{"_id":"5581fc9c8625220d00429f10","ref":"","in":"body","required":false,"desc":"Description of the coupon on the invoice.","default":"","type":"string","name":"invoice_description"},{"_id":"5581fc9c8625220d00429f0f","ref":"","in":"body","required":false,"desc":"Last date to redeem the coupon, defaults to no date.","default":"","type":"datetime","name":"redeem_by_date"},{"_id":"5581fc9c8625220d00429f0e","ref":"","in":"body","required":false,"desc":"DEPRECATED: Please use `duration`. If true, the coupon applies to the first invoice only.","default":"","type":"boolean","name":"single_use"},{"_id":"5581fc9c8625220d00429f0d","ref":"","in":"body","required":false,"desc":"DEPRECATED: Please use `temporal_unit` and `temporal_amount`. Number of months after redemption that the coupon is valid, defaults to no date.","default":"","type":"int","name":"applies_for_months"},{"_id":"5581fc9c8625220d00429f0c","ref":"","in":"body","required":false,"desc":"Maximum number of accounts that may use the coupon before it can no longer be redeemed.","default":"","type":"int","name":"max_redemptions"},{"_id":"5581fc9c8625220d00429f0b","ref":"","in":"body","required":false,"desc":"The coupon is valid for all plans if true, defaults to true.","default":"true","type":"boolean","name":"applies_to_all_plans"},{"_id":"55babe051b0d663700781631","ref":"","in":"body","required":false,"desc":"`forever`, `single_use`, or `temporal`.  If `single_use`, the coupon applies to the first invoice only.  If `temporal` the coupon will apply to invoices for the duration determined by the `temporal_unit` and `temporal_amount` attributes.","default":"forever","type":"string","name":"duration"},{"_id":"55babe051b0d663700781630","ref":"","in":"body","required":false,"desc":"`day`, `week`, `month`, or `year`.  If duration is `temporal` then `temporal_unit` is multiplied by `temporal_amount` to define the duration that the coupon will be applied to invoices for.","default":"","type":"string","name":"temporal_unit"},{"_id":"55babe051b0d66370078162f","ref":"","in":"body","required":false,"desc":"If duration is `temporal` then `temporal_amount` is an integer which is multiplied by `temporal_unit` to define the duration that the coupon will be applied to invoices for.","default":"","type":"int","name":"temporal_amount"},{"_id":"5612aac709bdc51700697025","ref":"","in":"body","required":false,"desc":"The coupon is valid for one-time, non-plan charges if `true`, defaults to `false`.","default":"false","type":"boolean","name":"applies_to_non_plan_charges"},{"_id":"5612aac709bdc51700697024","ref":"","in":"body","required":false,"desc":"Whether the discount is for all eligible charges on the account, or only a specific subscription. Values are `account` or `subscription`.","default":"account","type":"string","name":"redemption_resource"},{"_id":"5612aac709bdc51700697023","ref":"","in":"body","required":false,"desc":"The number of times the coupon can be redeemed on a specific account. `null` is the default and means unlimited.","default":"","type":"int","name":"max_redemptions_per_account"},{"_id":"5612aac709bdc51700697022","ref":"","in":"body","required":false,"desc":"Whether the coupon is `single_code` or `bulk`. Bulk coupons will require a `unique_code_template` and will generate unique codes through the generate endpoint.","default":"single_code","type":"string","name":"coupon_type"},{"_id":"5612aac709bdc51700697021","ref":"","in":"body","required":false,"desc":"The template for generating unique codes. See rules below for creating unique code templates.","default":"","type":"string","name":"unique_code_template"},{"_id":"5581fc9c8625220d00429f07","ref":"","in":"body","required":false,"desc":"Array of `plan_codes` the coupon applies to, if `applies_to_all_plans` is false.","default":"","type":"array_string","name":"plan_codes"}],"url":"/coupons"},"body":"**DISCOUNT IN DOLLARS**\nWhen specifying a discount amount as a flat amount, the currency must be specified with the amount in an array. For example:\n```\n<discount_type>dollars</discount_type>\n<discount_in_cents>\n  <USD>500</USD>\n  <EUR>400</EUR>\n  <GBP>300</GBP>\n</discount_in_cents>\n```\n**DISCOUNT IN PERCENTAGE**\nPercentage discounts only need to specify the discount percentage. For example:\n```\n<discount_type>percent</discount_type>\n<discount_percent>10</discount_percent>\n```\n**LIMITING TO SPECIFIC PLANS**\nIf a coupon applies to all plans, it will also apply to any plans created in the future. To limit a coupon to specific plans, you may specify an array of plan codes. For example:\n```\n<applies_to_all_plans>false</applies_to_all_plans>\n<plan_codes>\n  <plan_code>silver</plan_code>\n  <plan_code>gold</plan_code>\n</plan_codes>\n```\n**CREATING UNIQUE CODE TEMPLATES**\nIf you are creating a bulk coupon, you will need to create a unique_code_template. Here are the rules:\n1. You must start the template with your coupon_code wrapped in single quotes.\n2. Outside of single quotes, use a 9 for a character that you want to be a random number.\n3. Outside of single quotes, use an \"x\" for a character that you want to be a random letter.\n4. Outside of single quotes, use an * for a character that you want to be a random number or letter.\n5. Use single quotes ' ' for characters that you want to remain static. These strings can be alphanumeric and may contain a - _ or +.\n\n```\n<coupon_code>thankyou</coupon_code>\n<coupon_type>bulk</coupon_type>\n<unique_code_template>'thankyou'99999999</unique_code_template>\n```\nThis example will create a unique code like: thankyou41863675","category":"578e7c59b434c30e0035bf2d","createdAt":"2015-06-17T23:02:52.933Z","excerpt":"Creates a new coupon. Please note: coupons cannot be updated after being created.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"create-coupon","sync_unique":"","title":"Create Coupon","type":"post","updates":[],"user":"5581f6648625220d00429ef6","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

postCreate Coupon

Creates a new coupon. Please note: coupons cannot be updated after being created.

coupon_code:
required
string
Unique code to identify and redeem the coupon. This code may only contain the following characters: [a-z A-Z 0-9 + - _ ]. Max of 50 characters.
name:
required
string
Coupon name.
description:
string
Description of the coupon on the hosted payment pages.
discount_type:
required
string
`percent` or `dollars`.
discount_in_cents:
integer
Mapping of discount amounts by currency if discount_type is `dollars`. Max 10000000.
discount_percent:
integer
Discount percentage if discount_type is `percent`.
invoice_description:
string
Description of the coupon on the invoice.
redeem_by_date:
datetime
Last date to redeem the coupon, defaults to no date.
single_use:
boolean
DEPRECATED: Please use `duration`. If true, the coupon applies to the first invoice only.
applies_for_months:
integer
DEPRECATED: Please use `temporal_unit` and `temporal_amount`. Number of months after redemption that the coupon is valid, defaults to no date.
max_redemptions:
integer
Maximum number of accounts that may use the coupon before it can no longer be redeemed.
applies_to_all_plans:
booleantrue
The coupon is valid for all plans if true, defaults to true.
duration:
stringforever
`forever`, `single_use`, or `temporal`. If `single_use`, the coupon applies to the first invoice only. If `temporal` the coupon will apply to invoices for the duration determined by the `temporal_unit` and `temporal_amount` attributes.
temporal_unit:
string
`day`, `week`, `month`, or `year`. If duration is `temporal` then `temporal_unit` is multiplied by `temporal_amount` to define the duration that the coupon will be applied to invoices for.
temporal_amount:
integer
If duration is `temporal` then `temporal_amount` is an integer which is multiplied by `temporal_unit` to define the duration that the coupon will be applied to invoices for.
applies_to_non_plan_charges:
booleanfalse
The coupon is valid for one-time, non-plan charges if `true`, defaults to `false`.
redemption_resource:
stringaccount
Whether the discount is for all eligible charges on the account, or only a specific subscription. Values are `account` or `subscription`.
max_redemptions_per_account:
integer
The number of times the coupon can be redeemed on a specific account. `null` is the default and means unlimited.
coupon_type:
stringsingle_code
Whether the coupon is `single_code` or `bulk`. Bulk coupons will require a `unique_code_template` and will generate unique codes through the generate endpoint.
unique_code_template:
string
The template for generating unique codes. See rules below for creating unique code templates.
plan_codes:
array of strings
Array of `plan_codes` the coupon applies to, if `applies_to_all_plans` is false.

DISCOUNT IN DOLLARS
When specifying a discount amount as a flat amount, the currency must be specified with the amount in an array. For example:

<discount_type>dollars</discount_type>
<discount_in_cents>
  <USD>500</USD>
  <EUR>400</EUR>
  <GBP>300</GBP>
</discount_in_cents>

DISCOUNT IN PERCENTAGE
Percentage discounts only need to specify the discount percentage. For example:

<discount_type>percent</discount_type>
<discount_percent>10</discount_percent>

LIMITING TO SPECIFIC PLANS
If a coupon applies to all plans, it will also apply to any plans created in the future. To limit a coupon to specific plans, you may specify an array of plan codes. For example:

<applies_to_all_plans>false</applies_to_all_plans>
<plan_codes>
  <plan_code>silver</plan_code>
  <plan_code>gold</plan_code>
</plan_codes>

CREATING UNIQUE CODE TEMPLATES
If you are creating a bulk coupon, you will need to create a unique_code_template. Here are the rules:

  1. You must start the template with your coupon_code wrapped in single quotes.
  2. Outside of single quotes, use a 9 for a character that you want to be a random number.
  3. Outside of single quotes, use an "x" for a character that you want to be a random letter.
  4. Outside of single quotes, use an * for a character that you want to be a random number or letter.
  5. Use single quotes ' ' for characters that you want to remain static. These strings can be alphanumeric and may contain a - _ or +.
<coupon_code>thankyou</coupon_code>
<coupon_type>bulk</coupon_type>
<unique_code_template>'thankyou'99999999</unique_code_template>

This example will create a unique code like: thankyou41863675

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php

try {
  $coupon = new Recurly_Coupon();
  $coupon->coupon_code = 'gorby1';
  $coupon->redeem_by_date = '2016-07-04';
  $coupon->duration = 'single_use';
  $coupon->redemption_resource = 'subscription';
  $coupon->max_redemptions_per_account = 1;
  $coupon->applies_to_non_plan_charges = true;

  // $2 off...
  $coupon->name = 'Special $2 off coupon';
  $coupon->discount_type = 'dollars';
  $coupon->discount_in_cents->addCurrency('USD',200); // $2.00 discount

  // ...or 10% off.
  $coupon->name = 'Special 10% off';
  $coupon->discount_type = 'percent';
  $coupon->discount_percent = 10;

  // Limit to gold and platinum plans only.
  $coupon->applies_to_all_plans = false;
  $coupon->plan_codes = array('gold', 'platinum');

  $coupon->create();

  print "Coupon: $coupon";
} catch (Recurly_ValidationError $e) {
  print "Invalid data: $e";
}
coupon = Recurly::Coupon.new(
  :coupon_code    => 'special',
  :redeem_by_date => Date.new(2014, 1, 1),
  :duration     => 'single_use'
)

# $2 off...
coupon.name = 'Special $2 off coupon'
coupon.discount_type = 'dollars'
coupon.discount_in_cents = 2_00

# ...or 10% off.
coupon.name = 'Special 10% off'
coupon.discount_type = 'percent'
coupon.discount_percent = 10

# Limit to gold and platinum plans only.
coupon.applies_to_all_plans = false
coupon.plan_codes = %w(gold platinum)

# Limit redemption to specific subscription on account.
coupon.redemption_resource = 'subscription'

# Limit redemptions per account to a specific number.
coupon.max_redemptions_per_account = 1

# Discount should include one-time charges.
coupon.applies_to_non_plan_charges = true

coupon.save
coupon = Coupon(
  coupon_code='special',
  redeem_by_date=datetime.date(2014, 1, 1),
  duration='single_use'
)

# $2 off...
coupon.name = 'Special $2 off coupon'
coupon.discount_type = 'dollars'
coupon.discount_in_cents = Money(200)

# ...or 10% off.
coupon.name = 'Special 10% off'
coupon.discount_type = 'percent'
coupon.discount_percent = 10

# Limit to gold and platinum plans only.
coupon.applies_to_all_plans = False
coupon.plan_codes = ['gold', 'platinum']

# Limit redemption to specific subscription on account.
coupon.redemption_resource = 'subscription'

# Limit redemptions per account to a specific number.
coupon.max_redemptions_per_account = 1

# Discount should include one-time charges.
coupon.applies_to_non_plan_charges = True

coupon.save()
// new Coupon(<code>, <name>, <discount>)

// $2 off...
var coupon = new Coupon("special",
        "Special $2 off coupon", new Dictionary<string, int>() { { "USD", 200 } });

// ... or 10% off...
var coupon = new Coupon("special",
        "Special 10% off coupon", 10);

coupon.RedeemByDate = new DateTime(2017, 1, 1);
coupon.SingleUse = true;

// Limit to gold and platinum plans only.
coupon.AppliesToAllPlans = false;
coupon.Plans.Add("gold");
coupon.Plans.Add("silver");

// Other properties
coupon.RedeemByDate = new DateTime(2014, 1, 1);
coupon.SingleUse = true;
coupon.RedemptionResource = Coupon.RedemptionResourceType.Subscription;
coupon.MaxRedemptionsPerAccount = 1;
coupon.AppliesToNonPlanCharges = true;

coupon.Create();
<!-- For All Plans -->
<coupon>
  <coupon_code>special</coupon_code>
  <name>Special $2 off coupon</name>
  <discount_type>dollars</discount_type>
    <discount_in_cents>
    <USD>200</USD>
  </discount_in_cents>
  <redeem_by_date>2017-12-31</redeem_by_date>
  <duration>temporal</duration>
  <temporal_unit>day</temporal_unit>
  <temporal_amount>28</temporal_amount>
  <max_redemptions>200</max_redemptions>
  <max_redemptions_per_account>1</max_redemptions_per_account>
  <applies_to_all_plans>true</applies_to_all_plans>
</coupon>

<!-- For specific plan codes -->
<coupon>
  <coupon_code>subscription_special</coupon_code>
  <name>Special 10% off</name>
  <discount_type>percent</discount_type>
  <discount_percent>10</discount_percent>
  <redeem_by_date>2017-12-31</redeem_by_date>
  <max_redemptions>200</max_redemptions>
  <applies_to_all_plans>false</applies_to_all_plans>
  <plan_codes>
    <plan_code>gold</plan_code>
    <plan_code>platinum</plan_code>
  </plan_codes>
  <redemption_resource>subscription</redemption_resource>
</coupon>

Result Format

<coupon href="https://your-subdomain.recurly.com/v2/coupons/special">
  <redemptions href="https://your-subdomain.recurly.com/v2/coupons/special/redemptions"/>
  <coupon_code>special</coupon_code>
  <name>Special 10% off</name>
  <state>redeemable</state>
  <description nil="nil"/>
  <discount_type>percent</discount_type>
  <discount_percent type="integer">10</discount_percent>
  <invoice_description nil="nil"/>
  <redeem_by_date type="datetime">2017-12-31T00:00:00Z</redeem_by_date>
  <single_use type="boolean">true</single_use>
  <applies_for_months nil="nil"/>
  <max_redemptions type="integer">200</max_redemptions>
  <applies_to_all_plans type="boolean">false</applies_to_all_plans>
  <created_at type="datetime">2016-07-11T18:50:17Z</created_at>
  <updated_at type="datetime">2016-07-11T18:50:17Z</updated_at>
  <deleted_at nil="nil"/>
  <duration>single_use</duration>
  <temporal_unit nil="nil"/>
  <temporal_amount nil="nil"/>
  <applies_to_non_plan_charges type="boolean">false</applies_to_non_plan_charges>
  <redemption_resource>account</redemption_resource>
  <max_redemptions_per_account nil="nil"/>
  <coupon_type>single_code</coupon_type>
  <plan_codes type="array">
    <plan_code>gold</plan_code>
    <plan_code>platinum</plan_code>
  </plan_codes>
  <a name="redeem" href="https://your-subdomain.recurly.com/v2/coupons/special/redeem" method="post"/>
</coupon>


{"__v":0,"_id":"578e7c5ab434c30e0035bf97","api":{"examples":{"codes":[{"name":"","code":"<?php\n\ntry {\n  $coupon = Recurly_Coupon::get('special');\n  print \"Coupon: $coupon\\n\";\n} catch (Recurly_NotFoundError $e) {\n  print \"Coupon does not exist\";\n}","language":"php"},{"code":"coupon = Recurly::Coupon.find('special')","language":"ruby"},{"code":"coupon = Coupon.get('special')","language":"python"},{"code":"var coupon = Coupons.Get(\"special\");","language":"csharp"}]},"results":{"codes":[{"status":200,"language":"xml","code":"<coupon href=\"https://your-subdomain.recurly.com/v2/coupons/special\">\n  <redemptions href=\"https://your-subdomain.recurly.com/v2/coupons/special/redemptions\"/>\n  <coupon_code>special</coupon_code>\n  <name>Special 10% off</name>\n  <state>redeemable</state>\n  <description nil=\"nil\"/>\n  <discount_type>percent</discount_type>\n  <discount_percent type=\"integer\">10</discount_percent>\n  <invoice_description nil=\"nil\"/>\n  <redeem_by_date type=\"datetime\">2017-12-31T00:00:00Z</redeem_by_date>\n  <single_use type=\"boolean\">true</single_use>\n  <applies_for_months nil=\"nil\"/>\n  <max_redemptions type=\"integer\">200</max_redemptions>\n  <applies_to_all_plans type=\"boolean\">false</applies_to_all_plans>\n  <created_at type=\"datetime\">2016-07-11T18:50:17Z</created_at>\n  <updated_at type=\"datetime\">2016-07-11T18:50:17Z</updated_at>\n  <deleted_at nil=\"nil\"/>\n  <duration>single_use</duration>\n  <temporal_unit nil=\"nil\"/>\n  <temporal_amount nil=\"nil\"/>\n  <applies_to_non_plan_charges type=\"boolean\">false</applies_to_non_plan_charges>\n  <redemption_resource>account</redemption_resource>\n  <max_redemptions_per_account nil=\"nil\"/>\n  <coupon_type>single_code</coupon_type>\n  <plan_codes type=\"array\">\n    <plan_code>gold</plan_code>\n    <plan_code>platinum</plan_code>\n  </plan_codes>\n  <a name=\"redeem\" href=\"https://your-subdomain.recurly.com/v2/coupons/special/redeem\" method=\"post\"/>\n</coupon>","name":"Single Code"},{"code":"<coupon href=\"https://your-subdomain.recurly.com/v2/coupons/sprintdemos347\">\n  <redemptions href=\"https://your-subdomain.recurly.com/v2/coupons/savemore/redemptions\"/>\n  <unique_coupon_codes href=\"https://your-subdomain.recurly.com/v2/coupons/savemore/unique_coupon_codes\"/>\n  <coupon_code>savemore</coupon_code>\n  <name>Save More Annual Sale</name>\n  <state>redeemable</state>\n  <description nil=\"nil\"></description>\n  <discount_type>dollars</discount_type>\n  <discount_in_cents>\n  \t<USD type=\"integer\">2000</USD>\n  </discount_in_cents>\n  <invoice_description nil=\"nil\"></invoice_description>\n  <redeem_by_date nil=\"nil\"></redeem_by_date>\n  <single_use type=\"boolean\">false</single_use>\n  <applies_for_months nil=\"nil\"></applies_for_months>\n  <max_redemptions nil=\"nil\"></max_redemptions>\n  <applies_to_all_plans type=\"boolean\">true</applies_to_all_plans>\n  <created_at type=\"datetime\">2015-10-05T16:42:50Z</created_at>\n  <duration>temporal</duration>\n  <temporal_unit>day</temporal_unit>\n  <temporal_amount type=\"integer\">28</temporal_amount>\n  <applies_to_non_plan_charges type=\"boolean\">false</applies_to_non_plan_charges>\n  <redemption_resource>account</redemption_resource>\n  <max_redemptions_per_account type=\"integer\">1</max_redemptions_per_account>\n  <coupon_type>bulk</coupon_type>\n  <unique_code_template>'savemore'99999999</unique_code_template>\n  <deleted_at nil=\"nil\"></deleted_at>\n  <unique_coupon_codes_count type=\"integer\">100</unique_coupon_codes_count>\n  <plan_codes type=\"array\"></plan_codes>\n  <a name=\"generate\" href=\"https://your-subdomain.recurly.com/v2/coupons/savemore/generate\" method=\"post\"/>\n</coupon>","language":"xml","status":200,"name":"Bulk Coupon"},{"code":"<coupon href=\"https://your-subdomain.recurly.com/v2/coupons/savemore28945343\">\n  <bulk_coupon href=\"https://your-subdomain.recurly.com/v2/coupons/savemore\"/>\n  <redemption href=\"https://your-subdomain.recurly.com/v2/coupons/savemore28945343/redemption\"/>\n  <coupon_code>savemore28945343</coupon_code>\n  <name>Save More Annual Sale</name>\n  <state>maxed_out</state>\n  <description></description>\n  <discount_type>dollar</discount_type>\n  <discount_percent type=\"integer\">2000</discount_percent>\n  <invoice_description></invoice_description>\n  <redeem_by_date nil=\"nil\"></redeem_by_date>\n  <single_use type=\"boolean\">true</single_use>\n  <applies_for_months nil=\"nil\"></applies_for_months>\n  <max_redemptions nil=\"nil\"></max_redemptions>\n  <applies_to_all_plans type=\"boolean\">false</applies_to_all_plans>\n  <created_at type=\"datetime\">2015-10-05T16:42:50Z</created_at>\n  <duration>temporal</duration>\n  <temporal_unit>day</temporal_unit>\n  <temporal_amount type=\"integer\">28</temporal_amount>\n  <applies_to_non_plan_charges type=\"boolean\">false</applies_to_non_plan_charges>\n  <redemption_resource>account</redemption_resource>\n  <max_redemptions_per_account type=\"integer\">1</max_redemptions_per_account>\n  <coupon_type>unique_code</coupon_type>\n  <redeemed_at type=\"datetime\">2015-10-07T18:48:12Z</redeemed_at>\n  <deleted_at nil=\"nil\"></deleted_at>\n  <plan_codes type=\"array\"></plan_codes>\n  <a name=\"restore\" href=\"https://your-subdomain.recurly.com/v2/coupons/savemore28945343/restore\" method=\"put\"/>\n</coupon>","language":"xml","status":200,"name":"Unique Code"}]},"settings":"","auth":"required","params":[{"_id":"5783c9e36bcaf40e00a5d872","ref":"","in":"path","required":true,"desc":"Unique code to identify and redeem the coupon.","default":"","type":"string","name":"coupon_code"}],"url":"/coupons/:coupon_code"},"body":"","category":"578e7c59b434c30e0035bf2d","createdAt":"2015-06-17T22:55:45.346Z","excerpt":"Returns information about an active coupon.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"lookup-a-coupon","sync_unique":"","title":"Lookup Coupon","type":"get","updates":["5654b5aa48b4df0d00f67d9d","570fc426277cba22000c87d4"],"user":"5581f6648625220d00429ef6","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

getLookup Coupon

Returns information about an active coupon.

coupon_code:
required
string
Unique code to identify and redeem the coupon.

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php

try {
  $coupon = Recurly_Coupon::get('special');
  print "Coupon: $coupon\n";
} catch (Recurly_NotFoundError $e) {
  print "Coupon does not exist";
}
coupon = Recurly::Coupon.find('special')
coupon = Coupon.get('special')
var coupon = Coupons.Get("special");

Result Format

<coupon href="https://your-subdomain.recurly.com/v2/coupons/special">
  <redemptions href="https://your-subdomain.recurly.com/v2/coupons/special/redemptions"/>
  <coupon_code>special</coupon_code>
  <name>Special 10% off</name>
  <state>redeemable</state>
  <description nil="nil"/>
  <discount_type>percent</discount_type>
  <discount_percent type="integer">10</discount_percent>
  <invoice_description nil="nil"/>
  <redeem_by_date type="datetime">2017-12-31T00:00:00Z</redeem_by_date>
  <single_use type="boolean">true</single_use>
  <applies_for_months nil="nil"/>
  <max_redemptions type="integer">200</max_redemptions>
  <applies_to_all_plans type="boolean">false</applies_to_all_plans>
  <created_at type="datetime">2016-07-11T18:50:17Z</created_at>
  <updated_at type="datetime">2016-07-11T18:50:17Z</updated_at>
  <deleted_at nil="nil"/>
  <duration>single_use</duration>
  <temporal_unit nil="nil"/>
  <temporal_amount nil="nil"/>
  <applies_to_non_plan_charges type="boolean">false</applies_to_non_plan_charges>
  <redemption_resource>account</redemption_resource>
  <max_redemptions_per_account nil="nil"/>
  <coupon_type>single_code</coupon_type>
  <plan_codes type="array">
    <plan_code>gold</plan_code>
    <plan_code>platinum</plan_code>
  </plan_codes>
  <a name="redeem" href="https://your-subdomain.recurly.com/v2/coupons/special/redeem" method="post"/>
</coupon>
<coupon href="https://your-subdomain.recurly.com/v2/coupons/sprintdemos347">
  <redemptions href="https://your-subdomain.recurly.com/v2/coupons/savemore/redemptions"/>
  <unique_coupon_codes href="https://your-subdomain.recurly.com/v2/coupons/savemore/unique_coupon_codes"/>
  <coupon_code>savemore</coupon_code>
  <name>Save More Annual Sale</name>
  <state>redeemable</state>
  <description nil="nil"></description>
  <discount_type>dollars</discount_type>
  <discount_in_cents>
  	<USD type="integer">2000</USD>
  </discount_in_cents>
  <invoice_description nil="nil"></invoice_description>
  <redeem_by_date nil="nil"></redeem_by_date>
  <single_use type="boolean">false</single_use>
  <applies_for_months nil="nil"></applies_for_months>
  <max_redemptions nil="nil"></max_redemptions>
  <applies_to_all_plans type="boolean">true</applies_to_all_plans>
  <created_at type="datetime">2015-10-05T16:42:50Z</created_at>
  <duration>temporal</duration>
  <temporal_unit>day</temporal_unit>
  <temporal_amount type="integer">28</temporal_amount>
  <applies_to_non_plan_charges type="boolean">false</applies_to_non_plan_charges>
  <redemption_resource>account</redemption_resource>
  <max_redemptions_per_account type="integer">1</max_redemptions_per_account>
  <coupon_type>bulk</coupon_type>
  <unique_code_template>'savemore'99999999</unique_code_template>
  <deleted_at nil="nil"></deleted_at>
  <unique_coupon_codes_count type="integer">100</unique_coupon_codes_count>
  <plan_codes type="array"></plan_codes>
  <a name="generate" href="https://your-subdomain.recurly.com/v2/coupons/savemore/generate" method="post"/>
</coupon>
<coupon href="https://your-subdomain.recurly.com/v2/coupons/savemore28945343">
  <bulk_coupon href="https://your-subdomain.recurly.com/v2/coupons/savemore"/>
  <redemption href="https://your-subdomain.recurly.com/v2/coupons/savemore28945343/redemption"/>
  <coupon_code>savemore28945343</coupon_code>
  <name>Save More Annual Sale</name>
  <state>maxed_out</state>
  <description></description>
  <discount_type>dollar</discount_type>
  <discount_percent type="integer">2000</discount_percent>
  <invoice_description></invoice_description>
  <redeem_by_date nil="nil"></redeem_by_date>
  <single_use type="boolean">true</single_use>
  <applies_for_months nil="nil"></applies_for_months>
  <max_redemptions nil="nil"></max_redemptions>
  <applies_to_all_plans type="boolean">false</applies_to_all_plans>
  <created_at type="datetime">2015-10-05T16:42:50Z</created_at>
  <duration>temporal</duration>
  <temporal_unit>day</temporal_unit>
  <temporal_amount type="integer">28</temporal_amount>
  <applies_to_non_plan_charges type="boolean">false</applies_to_non_plan_charges>
  <redemption_resource>account</redemption_resource>
  <max_redemptions_per_account type="integer">1</max_redemptions_per_account>
  <coupon_type>unique_code</coupon_type>
  <redeemed_at type="datetime">2015-10-07T18:48:12Z</redeemed_at>
  <deleted_at nil="nil"></deleted_at>
  <plan_codes type="array"></plan_codes>
  <a name="restore" href="https://your-subdomain.recurly.com/v2/coupons/savemore28945343/restore" method="put"/>
</coupon>


{"__v":0,"_id":"578e7c5ab434c30e0035bf99","api":{"auth":"required","examples":{"codes":[{"name":"XML","code":"<coupon>\n  <number_of_unique_codes>200</number_of_unique_codes>\n</coupon>","language":"xml"}]},"params":[{"_id":"5618a0ab9420c40d00510833","ref":"","in":"body","required":false,"desc":"Number of unique codes you want to generate for the bulk coupon. Must be between 1 and 200.","default":"","type":"int","name":"number_of_unique_codes"},{"_id":"578d05a3d9c55c2000d4f1e1","ref":"","in":"path","required":true,"desc":"Unique code to identify and redeem the coupon.","default":"","type":"string","name":"coupon_code"}],"results":{"codes":[{"status":400,"language":"xml","code":"<error>\n  <symbol>number_of_unique_codes</symbol>\n  <description>You are limited to generating 200 at a time</description>\n</error>","name":"Request Too High"},{"status":400,"language":"xml","code":"<error>\n  <symbol>number_of_unique_codes</symbol>\n  <description>Number of unique codes cannot be generated; unique code creation is in progress, please wait for it to finish and try again</description>\n</error>","name":"Request In Progress"},{"name":"Max Reached","status":400,"language":"xml","code":"<error>\n  <symbol>number_of_unique_codes</symbol>\n  <description>Number of unique codes can only generate a total of 100000 codes</description>\n</error>"},{"name":"Not Bulk Coupon","status":400,"language":"xml","code":"<error>\n  <symbol>number_of_unique_codes</symbol>\n  <description>Coupon must be of type bulk to generate unique codes</description>\n</error>"},{"status":201,"language":"text","code":"HTTP/1.1 201 Created\nContent-Type: application/xml; charset=utf-8\nLocation: https://your-subdomain.recurly.com/v2/coupons/thankyou/unique_coupon_codes?cursor=1998184141762793924%3A1468970111&per_page=200"}]},"settings":"","url":"/coupons/:coupon_code/generate"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"View Unique Codes\"\n}\n[/block]\nThe response will include the location of the unique codes as link in the header:\n\n```\nhttps://your-subdomain.recurly.com/v2/coupons/savemore/unique_coupon_codes?cursor=1792526747654056328&per_page=200\n```","category":"578e7c59b434c30e0035bf2d","createdAt":"2015-10-10T05:22:51.540Z","excerpt":"Create unique codes for a bulk coupon. A bulk coupon can have up to 100,000 unique codes total. The generate endpoint allows up to 200 unique codes at a time. The endpoint can be called multiple times to create then number of unique codes you need.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"generate-unique-codes","sync_unique":"","title":"Generate Unique Codes","type":"post","updates":[],"user":"55b66dba6127b1250036446f","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

postGenerate Unique Codes

Create unique codes for a bulk coupon. A bulk coupon can have up to 100,000 unique codes total. The generate endpoint allows up to 200 unique codes at a time. The endpoint can be called multiple times to create then number of unique codes you need.

number_of_unique_codes:
integer
Number of unique codes you want to generate for the bulk coupon. Must be between 1 and 200.
coupon_code:
required
string
Unique code to identify and redeem the coupon.

View Unique Codes

The response will include the location of the unique codes as link in the header:

https://your-subdomain.recurly.com/v2/coupons/savemore/unique_coupon_codes?cursor=1792526747654056328&per_page=200

Definition

{{ api_url }}{{ page_api_url }}

Examples

<coupon>
  <number_of_unique_codes>200</number_of_unique_codes>
</coupon>

Result Format

<error>
  <symbol>number_of_unique_codes</symbol>
  <description>You are limited to generating 200 at a time</description>
</error>
<error>
  <symbol>number_of_unique_codes</symbol>
  <description>Number of unique codes cannot be generated; unique code creation is in progress, please wait for it to finish and try again</description>
</error>
<error>
  <symbol>number_of_unique_codes</symbol>
  <description>Number of unique codes can only generate a total of 100000 codes</description>
</error>
<error>
  <symbol>number_of_unique_codes</symbol>
  <description>Coupon must be of type bulk to generate unique codes</description>
</error>
HTTP/1.1 201 Created
Content-Type: application/xml; charset=utf-8
Location: https://your-subdomain.recurly.com/v2/coupons/thankyou/unique_coupon_codes?cursor=1998184141762793924%3A1468970111&per_page=200


{"__v":0,"_id":"578e7c5ab434c30e0035bf9a","api":{"examples":{"codes":[{"language":"php","code":"<?php\n\ntry {\n  $coupon = Recurly_Coupon::get('special');\n  $coupon->delete();\n\n  print \"Coupon: $coupon\";\n} catch (Recurly_NotFoundError $e) {\n  print \"Coupon not found: $e\";\n}","name":""},{"language":"ruby","code":"coupon = Recurly::Coupon.find('special')\ncoupon.destroy"},{"language":"python","code":"coupon = Coupon.get('special')\ncoupon.delete()"},{"language":"csharp","code":"var coupon = Coupons.Get(\"special\");\ncoupon.Deactivate();"}]},"results":{"codes":[{"code":"Status: 204 No Content","language":"xml","status":204}]},"settings":"","auth":"required","params":[{"_id":"578d05b984f5cd0e00891689","ref":"","in":"path","required":true,"desc":"Unique code to identify and redeem the coupon.","default":"","type":"string","name":"coupon_code"}],"url":"/coupons/:coupon_code"},"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Bulk Unique Coupons\",\n  \"body\": \"Use the coupon_code of the main coupon campaign, also known as the prefix, to expire all not yet redeemed unique codes in the campaign. Use the unique code's coupon_code in order to expire just the specific unique code.\"\n}\n[/block]","category":"578e7c59b434c30e0035bf2d","createdAt":"2015-06-17T23:28:22.499Z","excerpt":"Expire the coupon so customers can no longer redeem the coupon.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"deactivate-coupon","sync_unique":"","title":"Expire Coupon","type":"delete","updates":[],"user":"5581f6648625220d00429ef6","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

deleteExpire Coupon

Expire the coupon so customers can no longer redeem the coupon.

coupon_code:
required
string
Unique code to identify and redeem the coupon.

Bulk Unique Coupons

Use the coupon_code of the main coupon campaign, also known as the prefix, to expire all not yet redeemed unique codes in the campaign. Use the unique code's coupon_code in order to expire just the specific unique code.

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php

try {
  $coupon = Recurly_Coupon::get('special');
  $coupon->delete();

  print "Coupon: $coupon";
} catch (Recurly_NotFoundError $e) {
  print "Coupon not found: $e";
}
coupon = Recurly::Coupon.find('special')
coupon.destroy
coupon = Coupon.get('special')
coupon.delete()
var coupon = Coupons.Get("special");
coupon.Deactivate();

Result Format

Status: 204 No Content


{"__v":0,"_id":"578e7c5ab434c30e0035bf9b","api":{"examples":{"codes":[{"name":"","code":"<coupon>\n  <name>New Coupon Name</name>\n  <description>New coupon description for the hosted pages.</description>\n  <invoice_description>New coupon description for the invoice.</invoice_description>\n  <redeem_by_date>2017-12-31</redeem_by_date>\n  <max_redemptions>500</max_redemptions>\n  <max_redemptions_per_account>1</max_redemptions_per_account>\n</coupon>","language":"xml"}]},"results":{"codes":[{"name":"","code":"<coupon href=\"https://your-subdomain.recurly.com/v2/coupons/special\">\n  <redemptions href=\"https://your-subdomain.recurly.com/v2/coupons/special/redemptions\"/>\n  <coupon_code>special</coupon_code>\n  <name>New Coupon Name</name>\n  <state>redeemable</state>\n  <description>New coupon description for the hosted pages.</description>\n  <discount_type>percent</discount_type>\n  <discount_percent type=\"integer\">10</discount_percent>\n  <invoice_description>New coupon description for the invoice.</invoice_description>\n  <redeem_by_date type=\"datetime\">2017-12-31T00:00:00Z</redeem_by_date>\n  <single_use type=\"boolean\">true</single_use>\n  <applies_for_months nil=\"nil\"/>\n  <max_redemptions type=\"integer\">500</max_redemptions>\n  <applies_to_all_plans type=\"boolean\">false</applies_to_all_plans>\n  <created_at type=\"datetime\">2016-07-11T18:50:17Z</created_at>\n  <updated_at type=\"datetime\">2016-07-11T18:52:29Z</updated_at>\n  <deleted_at nil=\"nil\"/>\n  <duration>single_use</duration>\n  <temporal_unit nil=\"nil\"/>\n  <temporal_amount nil=\"nil\"/>\n  <applies_to_non_plan_charges type=\"boolean\">false</applies_to_non_plan_charges>\n  <redemption_resource>account</redemption_resource>\n  <max_redemptions_per_account type=\"integer\">1</max_redemptions_per_account>\n  <coupon_type>single_code</coupon_type>\n  <plan_codes type=\"array\">\n    <plan_code>gold</plan_code>\n    <plan_code>platinum</plan_code>\n  </plan_codes>\n  <a name=\"redeem\" href=\"https://your-subdomain.recurly.com/v2/coupons/special/redeem\" method=\"post\"/>\n</coupon>","language":"xml","status":200},{"name":"Field Not Editable","code":"<error>\n    <symbol>attributes_not_allowed</symbol>\n    <description>You are not allowed to edit attributes discount_type.</description>\n</error>","language":"xml","status":400}]},"settings":"","auth":"required","params":[{"_id":"561738644d9e4a17002a0de5","ref":"","in":"body","required":false,"desc":"Coupon name.","default":"","type":"string","name":"name"},{"_id":"561738644d9e4a17002a0de4","ref":"","in":"body","required":false,"desc":"Description of the coupon on the hosted payment pages.","default":"","type":"string","name":"description"},{"_id":"561738644d9e4a17002a0de3","ref":"","in":"body","required":false,"desc":"Description of the coupon on the invoice.","default":"","type":"string","name":"invoice_description"},{"_id":"561738644d9e4a17002a0de2","ref":"","in":"body","required":false,"desc":"Last date to redeem the coupon, defaults to no date.","default":"","type":"datetime","name":"redeem_by_date"},{"_id":"561738644d9e4a17002a0de1","ref":"","in":"body","required":false,"desc":"Maximum number of accounts that may use the coupon before it can no longer be redeemed.","default":"","type":"int","name":"max_redemptions"},{"_id":"561738644d9e4a17002a0de0","ref":"","in":"body","required":false,"desc":"The number of times the coupon can be redeemed on a specific account. `null` is the default and means unlimited.","default":"","type":"int","name":"max_redemptions_per_account"},{"_id":"578d05d52c6ddb0e003fd005","ref":"","in":"path","required":true,"desc":"Unique code to identify and redeem the coupon.","default":"","type":"string","name":"coupon_code"}],"url":"/coupons/:coupon_code"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Editing Bulk Coupons and Unique Codes\"\n}\n[/block]\nYou can edit a bulk coupon to change the rules of the campaign, but you cannot edit a unique code within the campaign.","category":"578e7c59b434c30e0035bf2d","createdAt":"2015-10-09T03:45:40.895Z","excerpt":"Edit a redeemable coupon to extend redemption rules. Only redeemable coupons can be edited and only the below params are editable.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":6,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"edit-coupon","sync_unique":"","title":"Edit Coupon","type":"put","updates":[],"user":"55b66dba6127b1250036446f","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

putEdit Coupon

Edit a redeemable coupon to extend redemption rules. Only redeemable coupons can be edited and only the below params are editable.

name:
string
Coupon name.
description:
string
Description of the coupon on the hosted payment pages.
invoice_description:
string
Description of the coupon on the invoice.
redeem_by_date:
datetime
Last date to redeem the coupon, defaults to no date.
max_redemptions:
integer
Maximum number of accounts that may use the coupon before it can no longer be redeemed.
max_redemptions_per_account:
integer
The number of times the coupon can be redeemed on a specific account. `null` is the default and means unlimited.
coupon_code:
required
string
Unique code to identify and redeem the coupon.

Editing Bulk Coupons and Unique Codes

You can edit a bulk coupon to change the rules of the campaign, but you cannot edit a unique code within the campaign.

Definition

{{ api_url }}{{ page_api_url }}

Examples

<coupon>
  <name>New Coupon Name</name>
  <description>New coupon description for the hosted pages.</description>
  <invoice_description>New coupon description for the invoice.</invoice_description>
  <redeem_by_date>2017-12-31</redeem_by_date>
  <max_redemptions>500</max_redemptions>
  <max_redemptions_per_account>1</max_redemptions_per_account>
</coupon>

Result Format

<coupon href="https://your-subdomain.recurly.com/v2/coupons/special">
  <redemptions href="https://your-subdomain.recurly.com/v2/coupons/special/redemptions"/>
  <coupon_code>special</coupon_code>
  <name>New Coupon Name</name>
  <state>redeemable</state>
  <description>New coupon description for the hosted pages.</description>
  <discount_type>percent</discount_type>
  <discount_percent type="integer">10</discount_percent>
  <invoice_description>New coupon description for the invoice.</invoice_description>
  <redeem_by_date type="datetime">2017-12-31T00:00:00Z</redeem_by_date>
  <single_use type="boolean">true</single_use>
  <applies_for_months nil="nil"/>
  <max_redemptions type="integer">500</max_redemptions>
  <applies_to_all_plans type="boolean">false</applies_to_all_plans>
  <created_at type="datetime">2016-07-11T18:50:17Z</created_at>
  <updated_at type="datetime">2016-07-11T18:52:29Z</updated_at>
  <deleted_at nil="nil"/>
  <duration>single_use</duration>
  <temporal_unit nil="nil"/>
  <temporal_amount nil="nil"/>
  <applies_to_non_plan_charges type="boolean">false</applies_to_non_plan_charges>
  <redemption_resource>account</redemption_resource>
  <max_redemptions_per_account type="integer">1</max_redemptions_per_account>
  <coupon_type>single_code</coupon_type>
  <plan_codes type="array">
    <plan_code>gold</plan_code>
    <plan_code>platinum</plan_code>
  </plan_codes>
  <a name="redeem" href="https://your-subdomain.recurly.com/v2/coupons/special/redeem" method="post"/>
</coupon>
<error>
    <symbol>attributes_not_allowed</symbol>
    <description>You are not allowed to edit attributes discount_type.</description>
</error>


{"__v":0,"_id":"578e7c5ab434c30e0035bf9c","api":{"examples":{"codes":[{"name":"","code":"<coupon>\n  <name>New Coupon Name</name>\n  <description>New coupon description for the hosted pages.</description>\n  <invoice_description>New coupon description for the invoice.</invoice_description>\n  <redeem_by_date>2017-12-31</redeem_by_date>\n  <max_redemptions>500</max_redemptions>\n  <max_redemptions_per_account>1</max_redemptions_per_account>\n</coupon>","language":"xml"}]},"results":{"codes":[{"name":"","code":"<coupon href=\"https://your-subdomain.recurly.com/v2/coupons/sprintdemos3456\">\n  <redemptions href=\"https://your-subdomain.recurly.com/v2/coupons/savemore/redemptions\" />\n  <coupon_code>savemore</coupon_code>\n  <name>New Coupon Name</name>\n  <state>redeemable</state>\n  <description>New coupon description for the hosted pages.</description>\n  <discount_type>percent</discount_type>\n  <discount_percent type=\"integer\">10</discount_percent>\n  <invoice_description>New coupon description for the invoice.</invoice_description>\n  <redeem_by_date type=\"datetime\">2017-12-31T00:00:00Z</redeem_by_date>\n  <single_use type=\"boolean\">false</single_use>\n  <applies_for_months nil=\"nil\" />\n  <max_redemptions type=\"integer\">500</max_redemptions>\n  <applies_to_all_plans type=\"boolean\">true</applies_to_all_plans>\n  <created_at type=\"datetime\">2016-06-05T16:42:32Z</created_at>\n  <duration>forever</duration>\n  <temporal_unit nil=\"nil\" />\n  <temporal_amount nil=\"nil\" />\n  <applies_to_non_plan_charges type=\"boolean\">false</applies_to_non_plan_charges>\n  <redemption_resource>account</redemption_resource>\n  <max_redemptions_per_account type=\"integer\">1</max_redemptions_per_account>\n  <coupon_type>single_code</coupon_type>\n  <deleted_at nil=\"nil\" />\n  <plan_codes type=\"array\" />\n  <a name=\"redeem\" href=\"https://your-subdomain.recurly.com/v2/coupons/savemore/redeem\" method=\"post\" />\n</coupon>","language":"xml","status":200},{"name":"Field Not Editable","code":"<error>\n    <symbol>attributes_not_allowed</symbol>\n    <description>You are not allowed to edit attributes discount_type.</description>\n</error>","language":"xml","status":400},{"code":"<error>\n    <symbol>active_coupon</symbol>\n    <description>Restoring an active coupon is not allowed</description>\n</error>","language":"xml","status":400,"name":"Active Coupon"}]},"settings":"","auth":"required","params":[{"_id":"5617ed9f26e3db230054fc1c","ref":"","in":"body","required":false,"desc":"Coupon name.","default":"","type":"string","name":"name"},{"_id":"5617ed9f26e3db230054fc1b","ref":"","in":"body","required":false,"desc":"Description of the coupon on the hosted payment pages.","default":"","type":"string","name":"description"},{"_id":"5617ed9f26e3db230054fc1a","ref":"","in":"body","required":false,"desc":"Description of the coupon on the invoice.","default":"","type":"string","name":"invoice_description"},{"_id":"5617ed9f26e3db230054fc19","ref":"","in":"body","required":false,"desc":"Last date to redeem the coupon, defaults to no date.","default":"","type":"datetime","name":"redeem_by_date"},{"_id":"5617ed9f26e3db230054fc18","ref":"","in":"body","required":false,"desc":"Maximum number of accounts that may use the coupon before it can no longer be redeemed.","default":"","type":"int","name":"max_redemptions"},{"_id":"5617ed9f26e3db230054fc17","ref":"","in":"body","required":false,"desc":"The number of times the coupon can be redeemed on a specific account. `null` is the default and means unlimited.","default":"","type":"int","name":"max_redemptions_per_account"},{"_id":"578d05e384f5cd0e0089168b","ref":"","in":"path","required":true,"desc":"Unique code to identify and redeem the coupon.","default":"","type":"string","name":"coupon_code"}],"url":"/coupons/:coupon_code/restore"},"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"If you aren't going to change anything in the restore action, include the coupon parameter: <coupon/>\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Restore Coupon That Reached Redeem By Date\"\n}\n[/block]\nIf your coupon has a redeem by date in the past, you must remove the date or change it to a future date, otherwise you will get this error:\n\n```\n<errors>\n    <error field=\"coupon.redeem_by_date\" symbol=\"in_past\">must be in the future</error>\n</errors>\n```\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Restore Coupon That Reached Max Redemptions\"\n}\n[/block]\nIf your coupon has reached it's max redemptions, you must remove the max redemptions or change it to a greater number. You cannot set max redemptions to anything less than the number of redemptions you have. If you do not update max redemptions in this case, you will get this error.\n\n```\n<errors>\n    <error field=\"coupon.max_redemptions\" symbol=\"too_low\">must be greater than 100</error>\n</errors>\n```\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Restoring Bulk Coupons or Unique Codes\"\n}\n[/block]\nRestoring a bulk coupon will restore the coupon campaign and all unique codes that have not been redeemed or individually expired.\n\nYou can restore an individual unique code if the bulk coupon is active by using the unique code's coupon code in the call.","category":"578e7c59b434c30e0035bf2d","createdAt":"2015-10-09T16:38:55.663Z","excerpt":"Make an expired coupon redeemable again. You can change editable fields in this call.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":7,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"restore-coupon","sync_unique":"","title":"Restore Coupon","type":"put","updates":[],"user":"55b66dba6127b1250036446f","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

putRestore Coupon

Make an expired coupon redeemable again. You can change editable fields in this call.

name:
string
Coupon name.
description:
string
Description of the coupon on the hosted payment pages.
invoice_description:
string
Description of the coupon on the invoice.
redeem_by_date:
datetime
Last date to redeem the coupon, defaults to no date.
max_redemptions:
integer
Maximum number of accounts that may use the coupon before it can no longer be redeemed.
max_redemptions_per_account:
integer
The number of times the coupon can be redeemed on a specific account. `null` is the default and means unlimited.
coupon_code:
required
string
Unique code to identify and redeem the coupon.

If you aren't going to change anything in the restore action, include the coupon parameter: <coupon/>

Restore Coupon That Reached Redeem By Date

If your coupon has a redeem by date in the past, you must remove the date or change it to a future date, otherwise you will get this error:

<errors>
    <error field="coupon.redeem_by_date" symbol="in_past">must be in the future</error>
</errors>

Restore Coupon That Reached Max Redemptions

If your coupon has reached it's max redemptions, you must remove the max redemptions or change it to a greater number. You cannot set max redemptions to anything less than the number of redemptions you have. If you do not update max redemptions in this case, you will get this error.

<errors>
    <error field="coupon.max_redemptions" symbol="too_low">must be greater than 100</error>
</errors>

Restoring Bulk Coupons or Unique Codes

Restoring a bulk coupon will restore the coupon campaign and all unique codes that have not been redeemed or individually expired.

You can restore an individual unique code if the bulk coupon is active by using the unique code's coupon code in the call.

Definition

{{ api_url }}{{ page_api_url }}

Examples

<coupon>
  <name>New Coupon Name</name>
  <description>New coupon description for the hosted pages.</description>
  <invoice_description>New coupon description for the invoice.</invoice_description>
  <redeem_by_date>2017-12-31</redeem_by_date>
  <max_redemptions>500</max_redemptions>
  <max_redemptions_per_account>1</max_redemptions_per_account>
</coupon>

Result Format

<coupon href="https://your-subdomain.recurly.com/v2/coupons/sprintdemos3456">
  <redemptions href="https://your-subdomain.recurly.com/v2/coupons/savemore/redemptions" />
  <coupon_code>savemore</coupon_code>
  <name>New Coupon Name</name>
  <state>redeemable</state>
  <description>New coupon description for the hosted pages.</description>
  <discount_type>percent</discount_type>
  <discount_percent type="integer">10</discount_percent>
  <invoice_description>New coupon description for the invoice.</invoice_description>
  <redeem_by_date type="datetime">2017-12-31T00:00:00Z</redeem_by_date>
  <single_use type="boolean">false</single_use>
  <applies_for_months nil="nil" />
  <max_redemptions type="integer">500</max_redemptions>
  <applies_to_all_plans type="boolean">true</applies_to_all_plans>
  <created_at type="datetime">2016-06-05T16:42:32Z</created_at>
  <duration>forever</duration>
  <temporal_unit nil="nil" />
  <temporal_amount nil="nil" />
  <applies_to_non_plan_charges type="boolean">false</applies_to_non_plan_charges>
  <redemption_resource>account</redemption_resource>
  <max_redemptions_per_account type="integer">1</max_redemptions_per_account>
  <coupon_type>single_code</coupon_type>
  <deleted_at nil="nil" />
  <plan_codes type="array" />
  <a name="redeem" href="https://your-subdomain.recurly.com/v2/coupons/savemore/redeem" method="post" />
</coupon>
<error>
    <symbol>attributes_not_allowed</symbol>
    <description>You are not allowed to edit attributes discount_type.</description>
</error>
<error>
    <symbol>active_coupon</symbol>
    <description>Restoring an active coupon is not allowed</description>
</error>


{"__v":1,"_id":"578eb2d87d6eeb0e004fb86a","api":{"auth":"required","examples":{"codes":[]},"params":[{"_id":"578eb2d87d6eeb0e004fb86b","ref":"","in":"path","required":true,"desc":"Unique code to identify and redeem the coupon.","default":"","type":"string","name":"coupon_code"},{"_id":"578eb356902f512200bd3fad","ref":"","in":"query","required":false,"desc":"The attribute that will be used to order records: `created_at`, `updated_at`.","default":"created_at","type":"string","name":"sort"},{"_id":"578eb356902f512200bd3fac","ref":"","in":"query","required":false,"desc":"The order in which products will be returned: `asc` for ascending order, `desc` for descending order.","default":"desc","type":"string","name":"order"},{"_id":"578eb356902f512200bd3fab","ref":"","in":"query","required":false,"desc":"Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes greater than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.","default":"","type":"datetime","name":"begin_time"},{"_id":"578eb356902f512200bd3faa","ref":"","in":"query","required":false,"desc":"Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes less than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.","default":"","type":"datetime","name":"end_time"},{"_id":"578eb356902f512200bd3fa9","ref":"","in":"query","required":false,"desc":"Number of records to return per page, up to a maximum of 200.","default":"50","type":"int","name":"per_page"},{"_id":"578eb356902f512200bd3fa8","ref":"","in":"query","required":false,"desc":"Splits records across pages. Leave blank to return the first page. Follow the URI in the first page's Link header to fetch the next page.","default":"","type":"string","name":"cursor"}],"results":{"codes":[{"name":"","code":"<unique_coupon_codes type=\"array\">\n  <coupon href=\"https://your-subdomain.recurly.com/v2/coupons/thankyou26871961\">\n    <bulk_coupon href=\"https://your-subdomain.recurly.com/v2/coupons/thankyou\"/>\n    <coupon_code>thankyou26871961</coupon_code>\n    <name>Special 10% off</name>\n    <state>redeemable</state>\n    <description nil=\"nil\"/>\n    <discount_type>percent</discount_type>\n    <discount_percent type=\"integer\">10</discount_percent>\n    <invoice_description nil=\"nil\"/>\n    <redeem_by_date nil=\"nil\"/>\n    <single_use type=\"boolean\">false</single_use>\n    <applies_for_months nil=\"nil\"/>\n    <max_redemptions nil=\"nil\"/>\n    <applies_to_all_plans type=\"boolean\">true</applies_to_all_plans>\n    <created_at type=\"datetime\">2016-07-19T23:15:12Z</created_at>\n    <updated_at type=\"datetime\">2016-07-19T23:15:12Z</updated_at>\n    <deleted_at nil=\"nil\"/>\n    <duration>forever</duration>\n    <temporal_unit nil=\"nil\"/>\n    <temporal_amount nil=\"nil\"/>\n    <applies_to_non_plan_charges type=\"boolean\">false</applies_to_non_plan_charges>\n    <redemption_resource>account</redemption_resource>\n    <max_redemptions_per_account nil=\"nil\"/>\n    <coupon_type>unique_code</coupon_type>\n    <redeemed_at nil=\"nil\"/>\n    <plan_codes type=\"array\">\n    </plan_codes>\n    <a name=\"redeem\" href=\"https://your-subdomain.recurly.com/v2/coupons/thankyou26871961/redeem\" method=\"post\"/>\n  </coupon>\n  <!-- Continued... -->\n</unique_coupon_codes>","language":"xml","status":200},{"name":"","code":"<error>\n  <symbol>not_found</symbol>\n  <description lang=\"en-US\">Couldn't find Coupon with coupon_code = specials</description>\n</error>","language":"xml","status":404}]},"settings":"","url":"/coupons/:coupon_code/unique_coupon_codes"},"body":"","category":"578e7c59b434c30e0035bf2d","createdAt":"2016-07-19T23:08:08.605Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":8,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"list-unique-coupon-codes","sync_unique":"","title":"List Unique Coupon Codes","type":"get","updates":[],"user":"559d85d26b21311700fb0b7b","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

getList Unique Coupon Codes


coupon_code:
required
string
Unique code to identify and redeem the coupon.
sort:
stringcreated_at
The attribute that will be used to order records: `created_at`, `updated_at`.
order:
stringdesc
The order in which products will be returned: `asc` for ascending order, `desc` for descending order.
begin_time:
datetime
Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes greater than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.
end_time:
datetime
Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes less than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.
per_page:
integer50
Number of records to return per page, up to a maximum of 200.
cursor:
string
Splits records across pages. Leave blank to return the first page. Follow the URI in the first page's Link header to fetch the next page.

Definition

{{ api_url }}{{ page_api_url }}

Result Format

<unique_coupon_codes type="array">
  <coupon href="https://your-subdomain.recurly.com/v2/coupons/thankyou26871961">
    <bulk_coupon href="https://your-subdomain.recurly.com/v2/coupons/thankyou"/>
    <coupon_code>thankyou26871961</coupon_code>
    <name>Special 10% off</name>
    <state>redeemable</state>
    <description nil="nil"/>
    <discount_type>percent</discount_type>
    <discount_percent type="integer">10</discount_percent>
    <invoice_description nil="nil"/>
    <redeem_by_date nil="nil"/>
    <single_use type="boolean">false</single_use>
    <applies_for_months nil="nil"/>
    <max_redemptions nil="nil"/>
    <applies_to_all_plans type="boolean">true</applies_to_all_plans>
    <created_at type="datetime">2016-07-19T23:15:12Z</created_at>
    <updated_at type="datetime">2016-07-19T23:15:12Z</updated_at>
    <deleted_at nil="nil"/>
    <duration>forever</duration>
    <temporal_unit nil="nil"/>
    <temporal_amount nil="nil"/>
    <applies_to_non_plan_charges type="boolean">false</applies_to_non_plan_charges>
    <redemption_resource>account</redemption_resource>
    <max_redemptions_per_account nil="nil"/>
    <coupon_type>unique_code</coupon_type>
    <redeemed_at nil="nil"/>
    <plan_codes type="array">
    </plan_codes>
    <a name="redeem" href="https://your-subdomain.recurly.com/v2/coupons/thankyou26871961/redeem" method="post"/>
  </coupon>
  <!-- Continued... -->
</unique_coupon_codes>
<error>
  <symbol>not_found</symbol>
  <description lang="en-US">Couldn't find Coupon with coupon_code = specials</description>
</error>


{"__v":1,"_id":"578e7c5ab434c30e0035bf9d","api":{"auth":"required","examples":{"codes":[{"name":"","code":"<?php\n\ntry {\n  $account = Recurly_Account::get('b6f5783');\n  if ($account->redemptions) {\n    $redemptions = $account->redemptions->get();\n    print \"Redemptions: $redemptions\";\n  }\n} catch (Recurly_NotFoundError $e) {\n  print \"Account not found: $e\";\n}","language":"php"},{"code":"account = Recurly::Account.find('1')\nredemptions = account.redemptions","language":"ruby"},{"code":"account = Account.get('1')\nredemptions = account.redemptions()","language":"python"},{"code":"var account = Accounts.Get(\"1\");\nvar redemptions = account.GetActiveRedemptions();","language":"csharp"}]},"params":[{"_id":"578d060e733f2f2000b1538f","ref":"","in":"path","required":true,"desc":"Unique account identifier.","default":"","type":"string","name":"account_code"},{"_id":"578eb2052c3c790e009376a1","ref":"","in":"query","required":false,"desc":"The attribute that will be used to order records: `created_at`, `updated_at`.","default":"created_at","type":"string","name":"sort"},{"_id":"578eb2052c3c790e009376a0","ref":"","in":"query","required":false,"desc":"The order in which products will be returned: `asc` for ascending order, `desc` for descending order.","default":"desc","type":"string","name":"order"},{"_id":"578eb2052c3c790e0093769f","ref":"","in":"query","required":false,"desc":"Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes greater than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.","default":"","type":"datetime","name":"begin_time"},{"_id":"578eb2052c3c790e0093769e","ref":"","in":"query","required":false,"desc":"Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes less than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.","default":"","type":"datetime","name":"end_time"},{"_id":"5783cb895cbce30e0074e220","ref":"","in":"query","required":false,"desc":"Number of records to return per page, up to a maximum of 200.","default":"50","type":"int","name":"per_page"},{"_id":"5783cb895cbce30e0074e221","ref":"","in":"query","required":false,"desc":"Splits records across pages. Leave blank to return the first page. Follow the URI in the first page's Link header to fetch the next page.","default":"","type":"string","name":"cursor"}],"results":{"codes":[{"name":"","code":"<redemptions type=\"array\">\n  <redemption href=\"https://your-subdomain.recurly.com/v2/accounts/1/redemptions/316a4213e8fa9e97390aff4995bda9e6\">\n    <coupon href=\"https://your-subdomain.recurly.com/v2/coupons/special\" />\n    <account href=\"https://your-subdomain.recurly.com/v2/accounts/1\" />\n    <subscription href=\"https://your-subdomain.recurly.com/v2/subscriptions/315fbd7a25b04f1333ea9f4418994fb5\" />\n    <uuid>316a4213e8fa9e97390aff4995bda9e6</uuid>\n    <single_use type=\"boolean\">false</single_use>\n    <total_discounted_in_cents type=\"integer\">0</total_discounted_in_cents>\n    <currency>USD</currency>\n    <state>active</state>\n    <created_at type=\"datetime\">2016-06-15T17:13:30Z</created_at>\n  </redemption>\n  <redemption href=\"https://your-subdomain.recurly.com/v2/accounts/1/redemptions/3169fd6127ff82ccbfa08a442188d575\">\n    <coupon href=\"https://your-subdomain.recurly.com/v2/coupons/special\" />\n    <account href=\"https://your-subdomain.recurly.com/v2/accounts/1\" />\n    <uuid>3169fd6127ff82ccbfa08a442188d575</uuid>\n    <single_use type=\"boolean\">false</single_use>\n    <total_discounted_in_cents type=\"integer\">1500</total_discounted_in_cents>\n    <currency>USD</currency>\n    <state>active</state>\n    <created_at type=\"datetime\">2016-05-27T12:34:56Z</created_at>\n  </redemption>\n</redemptions>","language":"xml","status":200}]},"settings":"","url":"/accounts/:account_code/redemptions"},"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"If you use the singular, \\\"redemption\\\", in the endpoint, you will only see the most recently redeemed redemption.\"\n}\n[/block]","category":"578e7c59b434c30e0035bf2e","createdAt":"2015-06-17T23:45:47.017Z","excerpt":"Lookup information about the coupon redemptions on an account. Active and naturally expired limited  duration redemptions will be returned. Redemptions removed from the account or expired single use coupons will not be returned.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"555fbba928249c1900618a82","slug":"lookup-a-coupon-redemption-on-an-account","sync_unique":"","title":"List Account's Coupon Redemptions","type":"get","updates":[],"user":"5581f6648625220d00429ef6","version":"578e7c59b434c30e0035bf25","childrenPages":[]}

getList Account's Coupon Redemptions

Lookup information about the coupon redemptions on an account. Active and naturally expired limited duration redemptions will be returned. Redemptions removed from the account or expired single use coupons will not be returned.

account_code:
required
string
Unique account identifier.
sort:
stringcreated_at
The attribute that will be used to order records: `created_at`, `updated_at`.
order:
stringdesc
The order in which products will be returned: `asc` for ascending order, `desc` for descending order.
begin_time:
datetime
Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes greater than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.
end_time:
datetime
Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes less than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.
per_page:
integer50
Number of records to return per page, up to a maximum of 200.
cursor:
string
Splits records across pages. Leave blank to return the first page. Follow the URI in the first page's Link header to fetch the next page.

If you use the singular, "redemption", in the endpoint, you will only see the most recently redeemed redemption.

Definition

{{ api_url }}{{ page_api_url }}

Examples

<?php

try {
  $account = Recurly_Account::get('b6f5783');
  if ($account->redemptions) {
    $redemptions = $account->redemptions->get();
    print "Redemptions: $redemptions";
  }
} catch (Recurly_NotFoundError $e) {
  print "Account not found: $e";
}
account = Recurly::Account.find('1')
redemptions = account.redemptions
account = Account.get('1')
redemptions = account.redemptions()
var account = Accounts.Get("1");
var redemptions = account.GetActiveRedemptions();

Result Format

<redemptions type="array">
  <redemption href="https://your-subdomain.recurly.com/v2/accounts/1/redemptions/316a4213e8fa9e97390aff4995bda9e6">
    <coupon href="https://your-subdomain.recurly.com/v2/coupons/special" />
    <account href="https://your-subdomain.recurly.com/v2/accounts/1" />
    <subscription href="https://your-subdomain.recurly.com/v2/subscriptions/315fbd7a25b04f1333ea9f4418994fb5" />
    <uuid>316a4213e8fa9e97390aff4995bda9e6</uuid>
    <single_use type="boolean">false</single_use>
    <total_discounted_in_cents type="integer">0</total_discounted_in_cents>
    <currency>USD</currency>
    <state>active</state>
    <created_at type="datetime">2016-06-15T17:13:30Z</created_at>
  </redemption>
  <redemption href="https://your-subdomain.recurly.com/v2/accounts/1/redemptions/3169fd6127ff82ccbfa08a442188d575">
    <coupon href="https://your-subdomain.recurly.com/v2/coupons/special" />
    <account href="https://your-subdomain.recurly.com/v2/accounts/1" />
    <uuid>3169fd6127ff82ccbfa08a442188d575</uuid>
    <single_use type="boolean">false</single_use>
    <total_discounted_in_cents type="integer">1500</total_discounted_in_cents>
    <currency>USD</currency>
    <state>active</state>
    <created_at type="datetime">2016-05-27T12:34:56Z</created_at>
  </redemption>
</redemptions>


{"__v":0,"_id":"578e7c5ab434c30e0035bf9e","api":{"examples":{"codes":[{"name":"","code":"<?php\n\n$invoice = Recurly_Invoice::get('1');\nif($invoice->redemptions) {\n  $redemptions = $invoice->redemptions->get();\n}","langua