{"_id":"5c0fed024d9964002ee38c9a","category":"5c0fed024d9964002ee38bfd","user":"5564a0073a61a72f0067cb22","project":"555fbba928249c1900618a82","parentDoc":null,"version":"5c0fed024d9964002ee38cbb","updates":["5595c7e9f44370190028891c","562aa244ed4bea0d00c11d8b","56bb4e10dabd992100b674f7","56f19a949791b22d0077ba0f"],"next":{"pages":[],"description":""},"createdAt":"2015-06-10T22:06:37.745Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"language":"json","status":200,"name":"","code":"{}"},{"code":"{}","language":"json","status":400,"name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"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.17' \\\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.17\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.2](https://dev.recurly.com/v2.2/docs)**, **[2.3](https://dev.recurly.com/v2.3/docs)**, **[2.4](https://dev.recurly.com/v2.4/docs)**, **[2.5](https://dev.recurly.com/v2.5/docs)**, **[2.6](https://dev.recurly.com/v2.6/docs)**, **[2.7](https://dev.recurly.com/v2.7/docs)**, **[2.8](https://dev.recurly.com/v2.8/docs)**, **[2.9](https://dev.recurly.com/v2.9/docs)**, **[2.10](https://dev.recurly.com/v2.10/docs)**, **[2.11](https://dev.recurly.com/v2.11/docs)**, **[2.12](https://dev.recurly.com/v2.12/docs)**, **[2.13](https://dev.recurly.com/v2.13/docs)**, **[2.14](https://dev.recurly.com/v2.14/docs)**, **[2.15](https://dev.recurly.com/v2.15/docs)**, **[2.16](https://dev.recurly.com/v2.16/docs)**, **[2.17](https://dev.recurly.com/v2.17/docs)**\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Public API Key\"\n}\n[/block]\nRecurly uses two 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.","excerpt":"","slug":"getting-started","type":"basic","title":"Authentication","__v":0,"childrenPages":[]}

{"_id":"5c0fed024d9964002ee38c9b","category":"5c0fed024d9964002ee38bfd","user":"559d85d26b21311700fb0b7b","parentDoc":null,"project":"555fbba928249c1900618a82","version":"5c0fed024d9964002ee38cbb","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-18T22:26:12.882Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"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.17](https://dev.recurly.com/v2.17/docs), [2.16](https://dev.recurly.com/v2.16/docs), [2.15](https://dev.recurly.com/v2.15/docs), [2.14](https://dev.recurly.com/v2.14/docs), [2.13](https://dev.recurly.com/v2.13/docs), [2.12](https://dev.recurly.com/v2.12/docs), \n[2.11](https://dev.recurly.com/v2.11/docs), [2.10](https://dev.recurly.com/v2.10/docs), [2.9](https://dev.recurly.com/v2.9/docs), [2.8](https://dev.recurly.com/v2.8/docs),  [2.7](https://dev.recurly.com/v2.7/docs), [2.6](https://dev.recurly.com/v2.6/docs), [2.5](https://dev.recurly.com/v2.5/docs), [2.4](https://dev.recurly.com/v2.4/docs), [2.3](https://dev.recurly.com/v2.3/docs), [2.2](https://dev.recurly.com/v2.2/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.17\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.17\n\nRequest and Response changes:\n\n- Changed Account request/response:\n    - Added `<exemption_certificate>` field. Allows merchants using the Vertex tax provider to associate an exemption certificate with the account to be included in any tax calculation requests for the account.\n\n- Changed `PUT /v2/subscriptions/:uuid/notes`:\n    - Added `<gateway_code>` tag to subscription xml. Allows subscription's `gateway_code` to be immediately updated.\n\n- Changed `PUT /v2/invoices/:uuid`:\n    - Added `<gateway_code>` tag to invoice xml. Allows invoice's `gateway_code` to be immediately updated.\n\n- Changed `POST v2/purchases` request:\n  - Allow `starts_at` to specify a future date when a subscription should start. Previous versions only allowed subscriptions to start immediately via this endpoint.\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.","excerpt":"","slug":"versioning","type":"basic","title":"API Versioning","__v":0,"childrenPages":[]}

{"_id":"5c0fed024d9964002ee38c9c","category":"5c0fed024d9964002ee38bfd","parentDoc":null,"project":"555fbba928249c1900618a82","user":"55648cf93b87582b003ab8b1","version":"5c0fed024d9964002ee38cbb","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-06-15T22:48:39.567Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"language":"json","status":400,"name":"","code":"{}"}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Next Link\"\n}\n[/block]\nThe amount of records returned 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 \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  \"title\": \"Counting Records\"\n}\n[/block]\nStarting with API version 2.6, you must explicitly make a `HEAD` request to get the server count. Endpoints that return a list of resources will respond to this request and include a header indicating the total number of records available. They will not contain the xml body. The server count is specified with the `X-Records` header. E.g., for an endpoint with 14 records:\n\n```\nX-Records: 14\n```\n\nYou can pass filtering parameters (described above) to narrow down the resources you wish to count. Consider the example of counting all `collected` invoices in `2016`. You can send a `HEAD` request to this endpoint then parse the count from the X-Records response header:\n\n```\nhttps://your-subdomain.recurly.com/v2/invoices?begin_time=2016-01-01T00:00:00&end_time=2017-01-01T00:00:00&state=collected\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\": \"# Pagination in the ruby client is done using\\n# the Recurly::Pager class.\\n\\n# You can also create a Pager directly from any resource\\nRecurly::Invoice.paginate.class\\n#=> Recurly::Resource::Pager\\n\\n# paginate optionally takes the sorting and filtering params\\n# if you want to specify them\\nopts = {\\n  begin_time: DateTime.new(2016,1,1),\\n  end_time: DateTime.new(2017,1,1),\\n  state: :collected,\\n  per_page: 10\\n}\\n\\n# find_each will fetch the pages for you\\n# until there are none left. It presents\\n# all the invoices on the server as a single enumerable\\nRecurly::Invoice.paginate(opts).find_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 do |invoice|\\n  puts invoice.invoice_number\\nend\\n\\n# 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\\naccount = Recurly::Account.find('my_account_code')\\n\\naccount.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      \"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      \"code\": \"using System.Linq;\\n\\nvar accounts = Accounts.List();\\nwhile (accounts.Any())\\n{\\n    foreach (var account in accounts)\\n        Console.WriteLine(account);\\n    accounts = accounts.Next;\\n}\",\n      \"language\": \"csharp\"\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]","excerpt":"","slug":"pagination","type":"basic","title":"Pagination","__v":0,"childrenPages":[]}

{"_id":"5c0fed024d9964002ee38c9d","category":"5c0fed024d9964002ee38bfd","parentDoc":null,"project":"555fbba928249c1900618a82","user":"55648cf93b87582b003ab8b1","version":"5c0fed024d9964002ee38cbb","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-06-15T22:49:59.038Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"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 and HEAD requests count towards the rate limit.\n\nOnce your site moves into production mode, Recurly will only rate limit GET and HEAD 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\nWhen your site reaches its rate limit, your site technical contact will receive an email alerting them of the issue. This email will be sent not more than once every three hours. Our support team will also be notified. Please reach out to Recurly support if you need assistance in resolving this issue.\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.","excerpt":"","slug":"rate-limits","type":"basic","title":"Rate Limits","__v":0,"childrenPages":[]}

{"_id":"5c0fed024d9964002ee38c9e","category":"5c0fed024d9964002ee38bfd","parentDoc":null,"user":"5564a0073a61a72f0067cb22","project":"555fbba928249c1900618a82","version":"5c0fed024d9964002ee38cbb","updates":["56cd46e949abf10b0036a1e6","59b1583ffff23e00100d1937"],"next":{"pages":[],"description":""},"createdAt":"2015-06-10T22:06:26.211Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":4,"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 either an array of the validation errors or a single error:\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```\n\n```\n<error>\n  <symbol>simultaneous_request</symbol>\n  <description>\n    A change for subscription 3cf89f0c3fcda0b15c50134f63856d4e is already in progress.\n  </description>\n</error>\n```","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.","slug":"welcome","type":"basic","title":"HTTP Status Codes","__v":0,"childrenPages":[]}

{"_id":"5c0fed024d9964002ee38c9f","category":"5c0fed024d9964002ee38bfe","parentDoc":null,"user":"55648cf93b87582b003ab8b1","project":"555fbba928249c1900618a82","version":"5c0fed024d9964002ee38cbb","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-06-26T18:21:30.595Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"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)","excerpt":"","slug":"integrations","type":"basic","title":"Integrations","__v":0,"childrenPages":[]}

{"_id":"5c0fed024d9964002ee38c53","category":"5c0fed024d9964002ee38bff","user":"55648cf93b87582b003ab8b1","project":"555fbba928249c1900618a82","parentDoc":null,"version":"5c0fed024d9964002ee38cbb","updates":["55940e20fd29b92300c262bf","55b2bfc0a74a380d00e290a6","55b2c0466862a10d00887adf","55bbb926a8400c2d00873f2a","565f689e413e06170093df6a","58d2b9a19c99c92f00646f8e","5977a75032f043002002f6d9","59b738dba50f750030f42a78","59ccac98e30e6c00300cef7d"],"next":{"pages":[],"description":""},"createdAt":"2015-06-26T18:25:56.960Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"code":"{}","language":"json","status":400,"name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"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[Java](https://github.com/killbilling/recurly-java-library)\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[GO](https://github.com/blacklightcms/recurly)\n[Node.js](https://github.com/ceejbot/recurring)\n[Elixir](https://github.com/bhelx/recurly-client-elixir)","excerpt":"","slug":"client-libraries","type":"basic","title":"Client Libraries","__v":0,"childrenPages":[]}

{"_id":"5c0fed024d9964002ee38c66","category":"5c0fed024d9964002ee38c00","parentDoc":null,"project":"555fbba928249c1900618a82","user":"5564a0073a61a72f0067cb22","version":"5c0fed024d9964002ee38cbb","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-04T22:51:11.649Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"language":"json","status":400,"name":"","code":"{}"}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"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.","excerpt":"","slug":"recurlyjs","type":"basic","title":"Recurly.js Overview","__v":0,"childrenPages":[]}

{"_id":"5c0fed024d9964002ee38c67","category":"5c0fed024d9964002ee38c00","parentDoc":null,"project":"555fbba928249c1900618a82","user":"55648cf93b87582b003ab8b1","version":"5c0fed024d9964002ee38cbb","updates":["570eb5f23160d10e0041df28"],"next":{"pages":[],"description":""},"createdAt":"2016-03-01T03:19:34.724Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"auth":"required","params":[],"url":""},"isReference":false,"order":1,"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.","excerpt":"","slug":"recurly-js-how-it-works","type":"basic","title":"How it Works","__v":0,"childrenPages":[]}

{"_id":"5c0fed024d9964002ee38c68","category":"5c0fed024d9964002ee38c00","project":"555fbba928249c1900618a82","user":"55648cf93b87582b003ab8b1","parentDoc":null,"version":"5c0fed024d9964002ee38cbb","updates":["57180cd7602b9c0e000dab2c","59095020269f1f2300349125"],"next":{"pages":[],"description":""},"createdAt":"2016-03-01T03:21:56.345Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"language":"json","status":200,"name":"","code":"{}"},{"name":"","code":"{}","language":"json","status":400}]},"auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"## Include\n\n```\n<script src=\"https://js.recurly.com/v4/recurly.js\"></script>\n<link href=\"https://js.recurly.com/v4/recurly.css\" rel=\"stylesheet\" type=\"text/css\">\n```\n\nTo begin, you'll include the Recurly.js script on your page.\n\nThis exposes a single global object, `recurly`.\n\nIt is not necessary to include recurly.css, but we highly recommend it while you're getting set up. It provides some helpful default styles to Recurly payment fields.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"The Recurly-hosted version of recurly.js is designed and updated to maintain compatibility with system update deployments that take place from time-to-time. Locally hosted versions of recurly.js run the risk of encountering issues with system interaction and incompatibility which may result in avoidable service interruptions on your client page. It is for this reason, we highly recommend against and do not support locally hosted copies of recurly.js.\",\n  \"title\": \"Self-Hosting Recurly.js\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Framework Support\",\n  \"body\": \"Due to the necessity of gathering customer payment date within iframe elements, and the nature of reactive framework re-rendering requirements, Recurly does not at this time provide native support for reactive frameworks like React and Angular.\"\n}\n[/block]\n## Configure\n\n```\nrecurly.configure('sc-ABCDEFGHI123456789');\n```\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\": \"Use Your Site's Public Key\"\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#L76-L88) 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. For this, we recommend using simple div elements.\n\nThere are two ways to display card fields to your customers: a combined card field, and individual card fields.\n\n### Combined card field\n\nThis is the simplest and most streamlined way to accept customer card date. Recurly will inject a single field that will accept all card data. This field is responsive to various device widths and includes helpful UX enhancements to make card entry as smooth as possible.\n[block:html]\n{\n  \"html\": \"<form id=\\\"recurly-js-sample-combined-card-form\\\">\\n  <div data-recurly=\\\"card\\\"></div>\\n</form>\"\n}\n[/block]\n\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=\\\"card\\\"></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]\n### Individual card fields\n\nIf you would like to display card fields separately from each other. This is helpful when the combined field does not fit your design needs.\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      \"name\": \"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 documents all possible input fields.**\n\n### Card fields\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field Name\",\n    \"h-1\": \"Example\",\n    \"h-2\": \"Description\",\n    \"1-0\": \"number\",\n    \"2-0\": \"month\",\n    \"3-0\": \"year\",\n    \"4-0\": \"first_name\",\n    \"5-0\": \"last_name\",\n    \"6-0\": \"cvv\",\n    \"1-1\": \"`4111-1111-1111-1111`\",\n    \"2-1\": \"`8` or `08`\",\n    \"3-1\": \"`22` or `2022`\",\n    \"4-1\": \"`Pat`\",\n    \"5-1\": \"`Smith`\",\n    \"6-1\": \"`123`\",\n    \"1-2\": \"Credit card number. **Required** if using individual card fields\",\n    \"2-2\": \"Card expiration month as a number. **Required** if using individual card fields\",\n    \"3-2\": \"Card expiration year as a number. **Required** if using individual card fields\",\n    \"4-2\": \"Cardholder first name. **Required**\",\n    \"5-2\": \"Cardholder last name. **Required**\",\n    \"6-2\": \"Card security code.\",\n    \"0-0\": \"card\",\n    \"0-1\": \"`4111-1111-1111-1111 08/22 123`\",\n    \"0-2\": \"Combined card field. **Required** if using the combined card field\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\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 fields\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## 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]","excerpt":"","slug":"recurly-js-getting-started","type":"basic","title":"Getting Started","__v":0,"childrenPages":[]}

{"_id":"5c0fed024d9964002ee38c69","category":"5c0fed024d9964002ee38c00","project":"555fbba928249c1900618a82","user":"57292bdb0388c70e00f3d8f3","parentDoc":null,"version":"5c0fed024d9964002ee38cbb","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-20T23:37:54.259Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"[block:api-header]\n{\n  \"title\": \"Example field style configuration\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"recurly.configure({\\n  publicKey: 'my-public-key',\\n  fields: {\\n    // affects all fields\\n    all: {\\n      style: {\\n        fontFamily: 'Helvetica, sans-serif'\\n      }\\n    },\\n\\n    // affects the combined card field\\n    card: {\\n      displayIcon: true,\\n      style: {\\n        fontSize: '1em',\\n        placeholder: {\\n          color: 'gray !important',\\n          fontWeight: 'bold',\\n          content: {\\n            number: 'Card number',\\n            cvv: 'CVC'\\n          }\\n        },\\n        invalid: {\\n          fontColor: 'red'\\n        }\\n      }\\n    },\\n\\n    // affects individual card field types\\n    number: {\\n      // Custom target selector\\n      selector: '#recurly-number',\\n      // Format the card number\\n      format: true\\n    },\\n    month: {\\n      // Display a month select on mobile devices\\n      inputType: 'mobileSelect',\\n      style: {\\n        placeholder: {\\n          content: 'MM'\\n        }\\n      }\\n    },\\n    year: {\\n      style: {\\n        placeholder: {\\n          content: 'YYYY'\\n        }\\n      }\\n    },\\n    cvv: {}\\n  }\\n});\",\n      \"language\": \"javascript\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n## Style Configuration\n\nSince card fields must be injected within iframes, any style properties within those iframes must be passed to `recurly.configure`. See the code example at right.\n\n### Styling the combined card field\n\nOptions unique to the combined card field are detailed in the following table. When passed into your `recurly.configure` call, each property must be nested within `fields.card`.\n\n#### Combined card field properties\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Default\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"displayIcon\",\n    \"0-1\": \"`true`\",\n    \"0-2\": \"if false, the card brand icon will be hidden\",\n    \"7-0\": \"style.placeholder\",\n    \"8-0\": \"style.placeholder.color\",\n    \"7-1\": \"`{}`\",\n    \"7-2\": \"Object\",\n    \"8-1\": \"`'#a3a3a7'`\",\n    \"8-2\": \"Font <a href=\\\"https://developer.mozilla.org/en-US/docs/Web/CSS/color\\\" target=\\\"_blank\\\">color</a> applied to all placeholder text.\",\n    \"9-0\": \"style.placeholder.content\",\n    \"9-1\": \"`{}`\",\n    \"9-2\": \"Object\",\n    \"10-0\": \"style.placeholder.content.number\",\n    \"10-1\": \"`'Card number'`\",\n    \"10-2\": \"Placeholder content for the number input.\",\n    \"11-0\": \"style.placeholder.content.expiry\",\n    \"11-1\": \"`'MM / YY'`\",\n    \"11-2\": \"Placeholder content for the expiry input.\",\n    \"12-0\": \"style.placeholder.content.cvv\",\n    \"12-1\": \"`'CVV'`\",\n    \"12-2\": \"Placeholder content for the card verification value input.\",\n    \"13-0\": \"style.invalid\",\n    \"13-1\": \"`{}`\",\n    \"13-2\": \"Object. Style to apply to input elements when they contain an invalid value. See [common field style properties](#section-common-field-style-properties).\",\n    \"14-0\": \"style.invalid.fontColor\",\n    \"14-1\": \"`'#a3a3a7'`\",\n    \"14-2\": \"Font <a href=\\\"https://developer.mozilla.org/en-US/docs/Web/CSS/color\\\" target=\\\"_blank\\\">color</a>  applied to invalid input elements.\",\n    \"3-0\": \"style\",\n    \"3-2\": \"See [common field style properties](#section-common-field-style-properties).\",\n    \"3-1\": \"`{}`\",\n    \"2-0\": \"selector\",\n    \"2-2\": \"Specify a custom target selector (e.g. `'#recurly-card'`)\",\n    \"1-0\": \"inputType\",\n    \"1-1\": \"`'text'`\",\n    \"1-2\": \"Modifies the input type of the card field.\\n`'text'` - text input for all fields.\\n`'mobileSelect'` - If the user is using a mobile device, a native expiry select interface will appear when entering the expiration date.\\n`'select'` - Expiration date will be input using a select field on all devices. Mobile devices will display an optimized interface.\",\n    \"15-0\": \"tabIndex\",\n    \"15-1\": \"\",\n    \"15-2\": \"<a href=\\\"https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex\\\" target=\\\"_blank\\\">tabIndex</a> property to be applied to the outer iframe.\",\n    \"4-0\": \"style.fontColor\",\n    \"4-1\": \"`'#545457'`\",\n    \"5-0\": \"style.fontFamily\",\n    \"5-1\": \"`'Source Sans Pro'`\",\n    \"6-0\": \"style.fontSize\",\n    \"6-1\": \"`'16px'`\",\n    \"4-2\": \"Font <a href=\\\"https://developer.mozilla.org/en-US/docs/Web/CSS/color\\\" target=\\\"_blank\\\">color</a> for each input element.\",\n    \"5-2\": \"<a href=\\\"https://developer.mozilla.org/en-US/docs/Web/CSS/font-family\\\" target=\\\"_blank\\\">font-family</a> for each input element.\",\n    \"6-2\": \"<a href=\\\"https://developer.mozilla.org/en-US/docs/Web/CSS/font-size\\\" target=\\\"_blank\\\">font-size</a> for each input element.\"\n  },\n  \"cols\": 3,\n  \"rows\": 16\n}\n[/block]\n### Styling the individual card fields\n\nOptions unique to the individual card fields are detailed in the following table. When passed into your `recurly.configure` call, each property must be nested within `fields.all` or a respective `fields.number`, `fields.month`, `fields.year`, or `fields.cvv` object.\n\n#### Individual card field properties\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Default\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"format\",\n    \"0-1\": \"`true`\",\n    \"0-2\": \"Enables contextual input formatting, injecting spaces to match the card brand, and forcing numeric input on expiry and cvv.\",\n    \"3-0\": \"style\",\n    \"3-1\": \"`{}`\",\n    \"3-2\": \"See [common field style properties](#section-common-field-style-properties).\",\n    \"4-0\": \"style.placeholder.color\",\n    \"4-2\": \"Font <a href=\\\"https://developer.mozilla.org/en-US/docs/Web/CSS/color\\\" target=\\\"_blank\\\">color</a>  applied to the placeholder text.\",\n    \"5-0\": \"style.placeholder.content\",\n    \"5-1\": \"`''`\",\n    \"5-2\": \"Placeholder content (e.g. `'Card number'`, `'CVV'`)\",\n    \"2-0\": \"selector\",\n    \"2-2\": \"Specify a custom target selector (e.g. `'#recurly-number'`)\",\n    \"1-0\": \"inputType\",\n    \"1-1\": \"`'text'`\",\n    \"1-2\": \"Modifies the input type of the expiry fields.\\n`'text'` - normal text input.\\n`'mobileSelect'` - If the user is using a mobile device, a native select interface will appear.\\n`'select'` - A select field will display on all devices.\\n\\n*Valid only on the `month`, and `year` fields.*\",\n    \"6-0\": \"tabIndex\",\n    \"6-2\": \"<a href=\\\"https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex\\\" target=\\\"_blank\\\">tabIndex</a>  property to be applied to the outer iframe.\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\n#### Common field style properties\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-2\": \"Reference\",\n    \"h-1\": \"Default\",\n    \"0-0\": \"style.fontColor\",\n    \"0-1\": \"`'black'`\",\n    \"0-2\": \"<a href=\\\"https://developer.mozilla.org/en-US/docs/Web/CSS/color\\\" target=\\\"_blank\\\">color</a>\",\n    \"1-0\": \"style.fontFamily\",\n    \"1-1\": \"`'Helvetica'`\",\n    \"1-2\": \"<a href=\\\"https://developer.mozilla.org/en-US/docs/Web/CSS/font-family\\\" target=\\\"_blank\\\">font-family</a>\",\n    \"2-0\": \"style.fontFeatureSettings\",\n    \"2-1\": \"`'normal'`\",\n    \"2-2\": \"<a href=\\\"https://developer.mozilla.org/en-US/docs/Web/CSS/font-feature-settings\\\" target=\\\"_blank\\\">font-feature-settings</a>\",\n    \"3-0\": \"style.fontKerning\",\n    \"4-0\": \"style.fontSize\",\n    \"5-0\": \"style.fontSmoothing\",\n    \"6-0\": \"style.fontStretch\",\n    \"7-0\": \"style.fontStyle\",\n    \"8-0\": \"style.fontVariant\",\n    \"9-0\": \"style.fontWeight\",\n    \"10-0\": \"style.letterSpacing\",\n    \"11-0\": \"style.lineHeight\",\n    \"12-0\": \"style.padding\",\n    \"3-1\": \"`'auto'`\",\n    \"4-1\": \"`'inherit'`\",\n    \"5-1\": \"`'auto'`\",\n    \"6-1\": \"`'normal'`\",\n    \"13-0\": \"style.textAlign\",\n    \"14-0\": \"style.textDecoration\",\n    \"15-0\": \"style.textRendering\",\n    \"16-0\": \"style.textShadow\",\n    \"17-0\": \"style.textTransform\",\n    \"7-1\": \"`'normal'`\",\n    \"8-1\": \"`'normal'`\",\n    \"9-1\": \"`'normal'`\",\n    \"10-1\": \"`'normal'`\",\n    \"11-1\": \"`'normal'`\",\n    \"12-1\": \"\",\n    \"13-1\": \"\",\n    \"15-1\": \"`'auto'`\",\n    \"16-1\": \"`'none'`\",\n    \"17-1\": \"`'none'`\",\n    \"3-2\": \"<a href=\\\"https://developer.mozilla.org/en-US/docs/Web/CSS/font-kerning\\\" target=\\\"_blank\\\">font-kerning</a>\",\n    \"4-2\": \"<a href=\\\"https://developer.mozilla.org/en-US/docs/Web/CSS/font-size\\\" target=\\\"_blank\\\">font-size</a>\",\n    \"5-2\": \"<a href=\\\"https://developer.mozilla.org/en-US/docs/Web/CSS/font-smoothing\\\" target=\\\"_blank\\\">font-smoothing</a>\",\n    \"6-2\": \"<a href=\\\"https://developer.mozilla.org/en-US/docs/Web/CSS/font-stretch\\\" target=\\\"_blank\\\">font-stretch</a>\",\n    \"7-2\": \"<a href=\\\"https://developer.mozilla.org/en-US/docs/Web/CSS/font-style\\\" target=\\\"_blank\\\">font-style</a>\",\n    \"8-2\": \"<a href=\\\"https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant\\\" target=\\\"_blank\\\">font-variant</a>\",\n    \"9-2\": \"<a href=\\\"https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight\\\" target=\\\"_blank\\\">font-weight</a>\",\n    \"10-2\": \"<a href=\\\"https://developer.mozilla.org/en-US/docs/Web/CSS/letter-spacing\\\" target=\\\"_blank\\\">letter-spacing</a>\",\n    \"11-2\": \"<a href=\\\"https://developer.mozilla.org/en-US/docs/Web/CSS/line-height\\\" target=\\\"_blank\\\">line-height</a>\",\n    \"12-2\": \"<a href=\\\"https://developer.mozilla.org/en-US/docs/Web/CSS/padding\\\" target=\\\"_blank\\\">padding</a>\",\n    \"13-2\": \"<a href=\\\"https://developer.mozilla.org/en-US/docs/Web/CSS/text-align\\\" target=\\\"_blank\\\">text-align</a>\",\n    \"14-2\": \"<a href=\\\"https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration\\\" target=\\\"_blank\\\">text-decoration</a>\",\n    \"15-2\": \"<a href=\\\"https://developer.mozilla.org/en-US/docs/Web/CSS/text-rendering\\\" target=\\\"_blank\\\">text-rendering</a>\",\n    \"16-2\": \"<a href=\\\"https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow\\\" target=\\\"_blank\\\">text-shadow</a>\",\n    \"17-2\": \"<a href=\\\"https://developer.mozilla.org/en-US/docs/Web/CSS/text-transform\\\" target=\\\"_blank\\\">text-transform</a>\"\n  },\n  \"cols\": 3,\n  \"rows\": 18\n}\n[/block]\n## CSS Classes\n\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    \"0-1\": \"Default styles for the div surrounding each field iframe.\",\n    \"1-0\": \"recurly-hosted-field-focus\",\n    \"1-1\": \"Applied when the user focuses on a field.\",\n    \"3-0\": \"recurly-hosted-field-number\",\n    \"3-1\": \"Default styles for the div surrounding the number field iframe.\",\n    \"4-0\": \"recurly-hosted-field-month\",\n    \"4-1\": \"Default styles for the div surrounding the month field iframe.\",\n    \"5-0\": \"recurly-hosted-field-year\",\n    \"5-1\": \"Default styles for the div surrounding the year field iframe.\",\n    \"6-0\": \"recurly-hosted-field-cvv\",\n    \"6-1\": \"Default styles for the div surrounding the cvv field iframe.\",\n    \"2-0\": \"recurly-hosted-field-card\",\n    \"2-1\": \"Default styles for the div surrounding the combined card field iframe.\"\n  },\n  \"cols\": 2,\n  \"rows\": 7\n}\n[/block]\n## Custom Fonts\n\nYou may specify font and placeholder text for card fields through `recurly.configure`. The example call above 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 within each field -- thus you may change any property if the window size changes.","excerpt":"","slug":"recurly-js-styling-card-fields","type":"basic","title":"Styling Card Fields","__v":0,"childrenPages":[]}

{"_id":"5c0fed024d9964002ee38c6a","category":"5c0fed024d9964002ee38c00","user":"55648cf93b87582b003ab8b1","parentDoc":null,"project":"555fbba928249c1900618a82","version":"5c0fed024d9964002ee38cbb","updates":["583606faf50e460f009179cd"],"next":{"pages":[],"description":""},"createdAt":"2016-03-01T04:39:30.344Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":4,"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# Reference\n[block:html]\n{\n  \"html\": \"<h3>\\n  <span class=\\\"pg-type-big pg-type type-fn\\\">fn</span>\\n  recurly.token\\n</h2>\"\n}\n[/block]\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.\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\": \"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    \"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.","excerpt":"","slug":"recurly-js-getting-a-token","type":"basic","title":"Getting a Token","__v":0,"childrenPages":[]}

{"_id":"5c0fed024d9964002ee38c6b","category":"5c0fed024d9964002ee38c00","parentDoc":null,"user":"55648cf93b87582b003ab8b1","project":"555fbba928249c1900618a82","version":"5c0fed024d9964002ee38cbb","updates":["5718f243459f6f0e0075070c"],"next":{"pages":[],"description":""},"createdAt":"2016-03-01T04:28:39.561Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":5,"body":"Create a new subscription with a token using one of our [client libraries](/docs/client-libraries) or [API v2](https://dev.recurly.com).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Recurly::Subscription.create! plan_code: :monthly_subscription,\\n  account: {\\n    account_code: 'pat_smith',\\n    currency: 'USD',\\n    billing_info: { token_id: 'TOKEN_ID' }\\n  }\",\n      \"language\": \"ruby\"\n    },\n    {\n      \"code\": \"subscription = recurly.Subscription(\\n  plan_code = 'monthly_subscription',\\n  currency = 'EUR',\\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\": \"$subscription = new Recurly_Subscription();\\n$subscription->plan_code = 'monthly_subscription';\\n$subscription->currency = 'EUR';\\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\": \"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. Since tokens may be used to create charges in Recurly, be sure to keep them safe and only transmit them over a secure connection.\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]","excerpt":"","slug":"recurly-js-using-a-token","type":"basic","title":"Using a Token","__v":0,"childrenPages":[]}

{"_id":"5c0fed024d9964002ee38c6c","category":"5c0fed024d9964002ee38c00","project":"555fbba928249c1900618a82","user":"55648cf93b87582b003ab8b1","parentDoc":null,"version":"5c0fed024d9964002ee38cbb","updates":["59095077651f500f001dd3f6"],"next":{"pages":[],"description":""},"createdAt":"2016-03-01T18:53:08.841Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":6,"body":"[block:api-header]\n{\n  \"title\": \"Example RecurlyState object\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  fields: {\\n    card: {\\n      brand: 'visa',\\n      cvv: {\\n        empty: false,\\n        focus: false,\\n        valid: true\\n      },\\n      empty: true,\\n      expiry: {\\n        empty: false,\\n        focus: false,\\n        valid: true\\n      },\\n      firstSix: '411111',\\n      focus: false,\\n      lastFour: '1111',\\n      number: {\\n        empty: false,\\n        focus: false,\\n        valid: true\\n      },\\n      valid: false\\n    },\\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  \"sidebar\": true\n}\n[/block]\nListen 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]\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### `change`\n\nThis event 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### `field:submit`\n\nThis event 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.","excerpt":"","slug":"recurly-js-events","type":"basic","title":"Events","__v":0,"childrenPages":[]}

{"_id":"5c0fed024d9964002ee38c6d","category":"5c0fed024d9964002ee38c00","project":"555fbba928249c1900618a82","user":"57292bdb0388c70e00f3d8f3","parentDoc":null,"version":"5c0fed024d9964002ee38cbb","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-12-02T11:17:01.032Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":7,"body":"Recurly.js supports Apple Pay out of the box. To get started, ensure your site is [configured to accept Apple Pay transactions](https://docs.recurly.com/v1.0/docs/apple-pay-on-the-web).\n\nSetting up your Apple Pay integration in Recurly.js involves two parts: a) displaying the button, and b) invoking the purchase flow.\n\n## Displaying the button\n\nYour button styling needs to adhere to [Apple’s specifications](https://developer.apple.com/apple-pay/web-human-interface-guidelines/).\n\nSee Apple's documentation on [Displaying the Apple Pay Button](https://developer.apple.com/documentation/applepayjs/displaying_apple_pay_buttons) for guidelines on display and styling the button.\n\n## Invoking the purchase flow\n\nConfigure a new instance of  `recurly.ApplePay` as follows.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var applePay = recurly.ApplePay({\\n  country: 'US',\\n  currency: 'USD',\\n  label: 'My Subscription', // This text will be displayed on the Apple Pay payment sheet as \\\"My Subscription\\\"\\n  total: '29.00'\\n});\\n\\n// When the ApplePay instance is ready, bind the Apple Pay button click\\n// to applePay.begin\\napplePay.ready(function () {\\n  $('#my-apple-pay-button').on('click', function () {\\n    applePay.begin();\\n  });\\n});\\n\\n// Handle errors. These may occur at any point in the Apple Pay flow\\napplePay.on('error', function (err) {\\n  // err.code, err.message\\n  console.error('Apple Pay error', err);\\n});\\n\\n// This will fire when the flow is completed and a token has been generated\\napplePay.on('token', function (token) {\\n  console.log('Apple Pay succeeded. Token:', token.id);\\n  // Submit the token to your server\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\n### Additional configuration\n\nIf you are using the `recurly.Pricing` class to calculate checkout prices, you may pass your pricing instance instead of providing a total.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var pricing = recurly.Pricing();\\n\\nvar applePay = recurly.ApplePay({\\n  // ...\\n  pricing: pricing\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nTo provide additional customer data to tokens generated by `recurly.ApplePay`, you may pass a form reference. `recurly.ApplePay` will collect customer data from the form just as would occur during credit card tokenization. See [Getting a Token](doc:recurly-js-getting-a-token) for more information on building such a form. \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var applePay = recurly.ApplePay({\\n  // ...\\n  form: document.querySelector('#my-payment-form')\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\n## Integration Notes\n\n  * Recurly.js will automatically pull in the billing info from the customer's Apple account if their Apple Pay setup is complete with full billing information in their Apple Wallet. If the user does **NOT** have a billing name or address attached to their card in their Apple Wallet, the Apple Pay flow will prompt the customer for a billing address.\n  * If you choose to include a Recurly.js payment form, any billing name or address fields entered on that form will be used instead of the address in the user's Apple Wallet; the token request will contain the fields entered on the payment form. If the form is completely empty of name and address inputs, the token request will contain the name and address chosen by the user during the Apple Pay flow.\n\n# Reference\n[block:html]\n{\n  \"html\": \"<h3>\\n  <span class=\\\"pg-type-big pg-type type-fn\\\">fn</span>\\n  recurly.ApplePay\\n</h2>\"\n}\n[/block]\n### Arguments\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"options\",\n    \"0-1\": \"Object\",\n    \"h-0\": \"Param\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"1-0\": \"options.country\",\n    \"2-0\": \"options.currency\",\n    \"3-0\": \"options.label\",\n    \"4-0\": \"[options.total]\",\n    \"5-0\": \"[options.pricing]\",\n    \"6-0\": \"[options.form]\",\n    \"1-1\": \"String\",\n    \"2-1\": \"String\",\n    \"3-1\": \"String\",\n    \"4-1\": \"String\",\n    \"5-1\": \"recurly.Pricing\",\n    \"6-1\": \"HTMLElement\",\n    \"4-2\": \"Total cost to display in the Apple Pay payment sheet. Required if options.pricing is not provided.\",\n    \"5-2\": \"If provided, will override options.total and provide the current total price on the Pricing instance when the Apple Pay flow is initiated.\",\n    \"6-2\": \"If provided, tokens generated by the `recurly.ApplePay` instance will include customer billing address from the form, overriding any billing address gathered from Apple Pay. See [Getting a Token](doc:recurly-js-getting-a-token) for all compatible fields.\",\n    \"3-2\": \"Purchase description to display in the Apple Pay payment sheet.\",\n    \"2-2\": \"ISO 4217 purchase currency (ex: 'USD')\",\n    \"1-2\": \"Your ISO 3166 country code (ex: 'US'). This is your country code as the merchant.\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\n### Returns\n\nA new `recurly.ApplePay` instance\n[block:html]\n{\n  \"html\": \"<h3>\\n  <span class=\\\"pg-type-big pg-type type-fn\\\">fn</span>\\n  applePay.ready\\n</h2>\"\n}\n[/block]\n### Arguments\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Param\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"callback\",\n    \"0-1\": \"Function\",\n    \"0-2\": \"Called when the ApplePay instance has completed initialization. Will immediately invoke if the instance is already initialized. The callback is called with no arguments.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n### Returns\n\nNothing.\n[block:html]\n{\n  \"html\": \"<h3>\\n  <span class=\\\"pg-type-big pg-type type-fn\\\">fn</span>\\n  applePay.begin\\n</h2>\"\n}\n[/block]\nInitiates Apple Pay payment sheet flow. Should be invoked by a user action, clicking the Apple Pay button on your payment page.\n\n### Arguments\n\nNone.\n\n### Returns\n\nNothing.\n\n## Events\n\n### `token`\n\nThis event is fired when the customer has completed the Apple Pay payment sheet flow. Recurly has received the payment details, and generated this token to be used in our API.\n\n#### Signature\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Param\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"token\",\n    \"0-1\": \"Object\",\n    \"1-0\": \"token.id\",\n    \"1-1\": \"String\",\n    \"1-2\": \"Token identifier to be sent to the API\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n### `error`\n\nThis event is emitted when any error is encountered, whether during setup of the Apple Pay payment sheet, or during payment authorization. It will be useful to display errors to your customer if a problem occurs during the Apple Pay flow.\n\n#### Signature\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Param\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"error\",\n    \"0-1\": \"RecurlyError\",\n    \"0-2\": \"An error describing the issue that occurred.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n#### Error codes\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Code\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"apple-pay-init-error\",\n    \"h-2\": \"Additional Properties\",\n    \"0-2\": \"`err` the originating RecurlyError\",\n    \"0-1\": \"A configuration issue has prevented initialization\",\n    \"1-0\": \"apple-pay-not-configured\",\n    \"2-0\": \"apple-pay-configuration-invalid\",\n    \"3-0\": \"apple-pay-merchant-validation-error\",\n    \"4-0\": \"apple-pay-payment-failure\",\n    \"1-1\": \"Your site does not have a gateway which supports Apple Pay\",\n    \"2-1\": \"There is an issue with your Apple Pay authentication information. Check your certificate and key values in your gateway configuration.\",\n    \"3-1\": \"Apple encountered an error validating your merchant credentials\",\n    \"4-1\": \"An error has occurred during tokenization, preventing the payment authorization\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","excerpt":"Use Recurly.js to process Apple Pay transactions.","slug":"recurly-js-apple-pay","type":"basic","title":"Apple Pay","__v":0,"childrenPages":[]}

{"_id":"5c0fed024d9964002ee38c6e","category":"5c0fed024d9964002ee38c00","parentDoc":null,"project":"555fbba928249c1900618a82","user":"55648cf93b87582b003ab8b1","version":"5c0fed024d9964002ee38cbb","updates":["59403323f84a32001ba5a47a"],"next":{"pages":[],"description":""},"createdAt":"2016-03-01T18:54:55.886Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":8,"body":"A PayPal transaction is handled entirely within the PayPal checkout flow in a new window. Your customer will authorize a transaction within PayPal. Recurly will then record the authorization and return a Recurly token to you as it does for other payment methods. You will need to use the token within our API before it expires, and expired tokens cannot be retrieved.\n\nFirst, place a button on your page specifically for checking out with PayPal.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button>Checkout with PayPal</button>\",\n      \"language\": \"html\"\n    }\n  ]\n}\n[/block]\nNext, create a new `recurly.PayPal` instance.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var paypal = recurly.PayPal({\\n  display: { displayName: ' My product ' }\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\n**if you're processing PayPal transactions with Braintree**, you'll pass a [client authorization](https://developers.braintreepayments.com/guides/authorization/tokenization-key/javascript/v2#obtaining-a-tokenization-key) during instantiation:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var paypal = recurly.PayPal({\\n  braintree: { clientAuthorization: MY_CLIENT_AUTHORIZATION }\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nYour instance must then be set up to handle error scenarios and start the checkout flow.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"paypal.on('error', function (err) {\\n  // err.code\\n  // err.message\\n  // [err.cause] if there is an embedded error\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nNext we must bind a listener to a user action on the button and have it trigger the `start` function on your `recurly.PayPal` instance. This will open the PayPal checkout flow.\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\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$('#paypal-button').on('click', function () {\\n  paypal.start();\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"the `start` function must be called within a user-initiated event like 'click' or 'touchend'\"\n}\n[/block]\nFinally, add a function to receive the token once your customer completes the checkout flow. At this point you will send the token id to your server to be used in the Recurly API to create a billing info for an account.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"paypal.on('token', function (token) {\\n  // token.id\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\n# Reference\n[block:html]\n{\n  \"html\": \"<h3>\\n  <span class=\\\"pg-type-big pg-type type-fn\\\">fn</span>\\n  recurly.PayPal\\n</h2>\"\n}\n[/block]\n### Arguments\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Param\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"options\",\n    \"0-1\": \"`Object`\",\n    \"0-2\": \"Optional.\",\n    \"1-0\": \"options.braintree\",\n    \"1-1\": \"`Object`\",\n    \"1-2\": \"Optional. Braintree configuration.\",\n    \"2-0\": \"options.braintree.clientAuthorization\",\n    \"2-1\": \"`String`\",\n    \"2-2\": \"If using Braintree to proces PayPal transactions, provide your client authorization code here.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n### Returns\n\nA new `recurly.PayPal` instance\n[block:html]\n{\n  \"html\": \"<h3>\\n  <span class=\\\"pg-type-big pg-type type-fn\\\">fn</span>\\n  payPal.start\\n</h2>\"\n}\n[/block]\n### Arguments\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"options\",\n    \"0-1\": \"`Object`\",\n    \"0-2\": \"Optional\",\n    \"1-0\": \"options.description\",\n    \"1-1\": \"`String`\",\n    \"1-2\": \"Optional. In legacy PayPal flows, this description will be displayed during the checkout flow.\",\n    \"h-0\": \"Param\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n### Returns\n\nNothing.\n\n## Events\n\n### `error`\n\nThis event is emitted when any error is encountered, whether during setup of the PayPal flow, or during the checkout process. It will be useful to display errors to your customer if a problem occurs during PayPal checkout.\n\n#### Signature\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"error\",\n    \"0-1\": \"`RecurlyError`\",\n    \"0-2\": \"An error describing the issue that occurred\",\n    \"h-0\": \"Param\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n### `cancel`\n\nThis event is emitted when the customer has canceled the PayPal checkout flow before completion. You may wish to reset parts of your checkout experience if this occurs.\n\n#### Signature\n\nNone.\n\n### `token`\n\nThis event is fired when the customer has completed the PayPal checkout flow. Recurly has received the payment details, and generated this token to be used in our API.\n\n#### Signature\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"token\",\n    \"0-1\": \"`Object`\",\n    \"1-0\": \"token.id\",\n    \"1-1\": \"`String`\",\n    \"1-2\": \"Token identifier to be sent to the API\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]","excerpt":"Use Recurly to process PayPal transactions using PayPal Business or Braintree.","slug":"recurly-js-paypal","type":"basic","title":"PayPal","__v":0,"childrenPages":[]}

{"_id":"5c0fed024d9964002ee38c6f","category":"5c0fed024d9964002ee38c00","parentDoc":null,"project":"555fbba928249c1900618a82","user":"55648cf93b87582b003ab8b1","version":"5c0fed024d9964002ee38cbb","updates":["59094f4fb662a10f00aeed9e"],"next":{"pages":[],"description":""},"createdAt":"2016-03-01T18:58:37.649Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":9,"body":"Recurly automates complicated subscriptions, with many factors influencing total subscription price. With this in mind, Recurly.js provides a robust `recurly.Pricing` class designed to make determining actual subscription costs as simple and flexible as possible.\n\nA Recurly.js pricing instance 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# Reference\n[block:html]\n{\n  \"html\": \"<h3>\\n  <span class=\\\"pg-type-big pg-type type-fn\\\">fn</span>\\n  recurly.Pricing\\n</h2>\"\n}\n[/block]\n\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\nA new `recurly.Pricing` instance.\n[block:html]\n{\n  \"html\": \"<h3>\\n  <span class=\\\"pg-type-big pg-type type-fn\\\">fn</span>\\n  pricing.attach\\n</h2>\"\n}\n[/block]\nGiven the following example HTML structure\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    \"9-0\": \"gift_card\",\n    \"9-1\": \"`518822D87268C142`\",\n    \"9-2\": \"Gift card's redemption code.\"\n  },\n  \"cols\": 3,\n  \"rows\": 10\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    \"8-0\": \"gift_card_now\",\n    \"9-0\": \"gift_card_next\",\n    \"8-1\": \"`75.00`\",\n    \"9-1\": \"`25.00`\",\n    \"8-2\": \"The gift card amount that will be applied to the purchase today.\",\n    \"9-2\": \"The remainder gift card amount that will be applied to the next renewal.\"\n  },\n  \"cols\": 3,\n  \"rows\": 10\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[block:api-header]\n{\n  \"title\": \"Example Pricing State Object\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"emitted by the **change** event.\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\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  \"sidebar\": true\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### `Change`\n\nThis event 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### `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    \"7-0\": \"`set.gift_card`\",\n    \"7-1\": \"Gift card object.\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\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\\t.giftcard('518822D87268C142')\\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]","excerpt":"","slug":"recurly-js-pricing","type":"basic","title":"Pricing","__v":0,"childrenPages":[]}

{"_id":"5c0fed024d9964002ee38c70","category":"5c0fed024d9964002ee38c00","project":"555fbba928249c1900618a82","user":"57292bdb0388c70e00f3d8f3","parentDoc":null,"version":"5c0fed024d9964002ee38cbb","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-12-02T10:05:55.084Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":10,"body":"Recurly.js provides a fraud protection suite with support for our [Fraud Management](https://docs.recurly.com/v1.0/docs/fraud-management) toolkit, [Kount](https://docs.recurly.com/v1.0/docs/kount) integration, and [Braintree](https://docs.recurly.com/v1.0/docs/additional#section-braintree) gateway integration.\n\nWith fraud protection enabled, tokens created with Recurly.js will include device data we use to analyze fraud risk and flag subsequent transactions accordingly. Configuration is simple.\n\n## Configuring Fraud Protection\n\nOnce you have enabled fraud protection on your site, modify your Recurly.js configuration call according to your fraud protection setup.\n\n### Recurly Fraud Management & Kount Integration\n\nRecurly.js will handle all device data collection when configured as follows.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"recurly.configure({\\n  // ...\\n  fraud: {\\n    kount: { dataCollector: true }\\n  }\\n  // ..\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nThis will enable device data collection and automatically apply it to your tokens.\n\n### Braintree Gateway Fraud Integration\n\nFirst, you will need to collect device data [using the Braintree JavaScript client](https://developers.braintreepayments.com/guides/advanced-fraud-tools/client-side/javascript/v2). This is required by Braintree.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"// Collect device data using braintree client\\n// ...\\n\\nvar deviceData = braintreeInstance.deviceData;\\n\\nrecurly.configure({\\n  // ...\\n  fraud: {\\n    braintree: { deviceData: deviceData }\\n  }\\n  // ..\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nThis will apply Braintree fraud data to your tokens generated by Recurly.js. Transactions created with those tokens will pass the fraud data to Braintree for fraud analysis.","excerpt":"","slug":"recurly-js-fraud","type":"basic","title":"Fraud","__v":0,"childrenPages":[]}

{"_id":"5c0fed024d9964002ee38c71","category":"5c0fed024d9964002ee38c00","parentDoc":null,"project":"555fbba928249c1900618a82","user":"55648cf93b87582b003ab8b1","version":"5c0fed024d9964002ee38cbb","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-01T19:17:35.326Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"code":"{}","language":"json","status":200,"name":""},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":11,"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\nIt is also possible to inspect the validation state of hosted fields as your customer types, by listening to the ['change' event](doc:recurly-js-events).\n\n# Reference\n[block:html]\n{\n  \"html\": \"<h3>\\n  <span class=\\\"pg-type-big pg-type type-fn\\\">fn</span>\\n  recurly.bankAccount.bankInfo\\n</h2>\"\n}\n[/block]\nRetrieves bank info based from a given routing number.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"recurly.bankAccount.bankInfo({ routingNumber: '123456780' }, function (err, bankInfo) {\\n  if (err) {\\n    // err.code, err.message\\n  } else {\\n    // bankInfo.bank_name\\n  }\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\n### Arguments\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Param\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"options\",\n    \"0-1\": \"`Object`\",\n    \"0-2\": \"\",\n    \"1-0\": \"options.routingNumber\",\n    \"1-1\": \"`String`\",\n    \"1-2\": \"The routing number for a bank (ex: '123456780')\",\n    \"2-0\": \"callback\",\n    \"2-1\": \"`Function`\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n### Callback signature\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Param\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"err\",\n    \"0-1\": \"`RecurlyError` or `undefined`\",\n    \"0-2\": \"Error. Usually `invalid-routing-number`\",\n    \"1-1\": \"`Object`\",\n    \"1-2\": \"\",\n    \"1-0\": \"bankInfo\",\n    \"2-0\": \"bankInfo.bank_name\",\n    \"2-1\": \"`String`\",\n    \"2-2\": \"Bank institution name (ex: `Bank of Recurly`)\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","excerpt":"","slug":"recurly-js-validation","type":"basic","title":"Validation","__v":0,"childrenPages":[]}

{"_id":"5c0fed024d9964002ee38c72","category":"5c0fed024d9964002ee38c00","parentDoc":null,"user":"55648cf93b87582b003ab8b1","project":"555fbba928249c1900618a82","version":"5c0fed024d9964002ee38cbb","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-01T19:19:09.515Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":12,"body":"[block:api-header]\n{\n  \"title\": \"Example RecurlyError object\",\n  \"sidebar\": true\n}\n[/block]\n\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\": \"javascript\"\n    }\n  ],\n  \"sidebar\": true\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\": \"missing-hosted-field-target\",\n    \"4-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\": \"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    \"4-1\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\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    \"5-0\": \"\",\n    \"5-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    \"4-0\": \"gift-card-currency-mismatch\",\n    \"4-1\": \"Occurs when a gift card is redeemed with a currency that doesn't match the instance's configured currency.\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\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]","excerpt":"","slug":"recurly-js-errors","type":"basic","title":"Errors","__v":0,"childrenPages":[]}

{"_id":"5c0fed024d9964002ee38c73","category":"5c0fed024d9964002ee38c00","parentDoc":null,"project":"555fbba928249c1900618a82","user":"55648cf93b87582b003ab8b1","version":"5c0fed024d9964002ee38cbb","updates":["582136261142c82700b03347"],"next":{"pages":[],"description":""},"createdAt":"2016-03-01T19:35:36.709Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"language":"json","status":400,"name":"","code":"{}"}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":13,"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)","excerpt":"","slug":"recurly-js-examples","type":"basic","title":"Examples","__v":0,"childrenPages":[]}

{"_id":"5c0fed024d9964002ee38cb8","project":"555fbba928249c1900618a82","version":"5c0fed024d9964002ee38cbb","category":"5c0fed024d9964002ee38c00","user":"57292bdb0388c70e00f3d8f3","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-08-30T21:13:31.318Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":14,"body":"[block:api-header]\n{\n  \"title\": \"Upgrading from v3\"\n}\n[/block]\nRecurly.js v4 introduced the concept of hosted fields. These are a more secure method of capturing customer card data, ensuring that their payment information is never exposed to your payment form. This is a huge benefit for security and reduced PCI compliance exposure.\n\nFirst, you will need to update your payment form. The credit card fields `number`, `month`, `year`, and `cvv` will need to be removed and replaced with a container element in the form `<div data-recurly=\"card\"></div>`. We recommend using the card field since it includes a handful of validation and UX improvements, but it is also possible to use separate fields for the number, month, year, and cvv. This is explained more completely in the [Getting Started](doc:recurly-js-getting-started) section.\n\nYour `recurly.token` call may also need to be updated. It is now necessary to pass a reference to your checkout `<form>` that contains the hosted fields. Your callback function requires no modification. More info is available in the [Getting a Token](doc:recurly-js-getting-a-token) section.\n\nYou'll notice that the hosted fields won't look like the rest of your payment form inputs. That is because they are in fact iframes, and will need to be styled in order to get them to look right. We provide a stylesheet that works as a good baseline for styling the hosted fields to your needs (See the [Getting Started](doc:recurly-js-getting-started) section). To tweak styles further, and to cover styles for when the field is invalid, etc, see the [Styling Card Fields](doc:recurly-js-styling-card-fields) section.\n\nWe are happy to assist further in your upgrade path. Feel free to reach out to us for [Support](doc:recurly-js-support).\n[block:api-header]\n{\n  \"title\": \"Upgrading from versions prior to v3\"\n}\n[/block]\nSince version 3, Recurly.js shifted to credit card tokenization as its method of billing info capture. Given the significant changes, upgrading from an earlier version of Recurly.js will require a full rewrite of your integration. Please see the [Getting Started](doc:recurly-js-getting-started) section to begin.","excerpt":"Upgrading from previous versions of Recurly.js","slug":"recurly-js-upgrading","type":"basic","title":"Upgrading","__v":0,"parentDoc":null,"childrenPages":[]}

{"_id":"5c0fed024d9964002ee38c74","category":"5c0fed024d9964002ee38c00","parentDoc":null,"project":"555fbba928249c1900618a82","user":"55648cf93b87582b003ab8b1","version":"5c0fed024d9964002ee38cbb","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-01T19:37:11.437Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"name":"","code":"{}","language":"json"},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":15,"body":"Recurly.js supports Chrome, Firefox, Safari, iOS, Edge, and IE 11+.\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.","excerpt":"","slug":"recurly-js-support","type":"basic","title":"Support","__v":0,"childrenPages":[]}

{"_id":"5c0fed024d9964002ee38c50","category":"5c0fed024d9964002ee38c01","project":"555fbba928249c1900618a82","user":"55957fd09b8d0a25005a7d30","parentDoc":null,"version":"5c0fed024d9964002ee38cbb","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-05-16T20:47:47.026Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"name":"","code":"<invoice_collection>\n  <charge_invoice>\n    <account href=\"https://your-subdomain.recurly.com/v2/accounts/1\"/>\n    <subscriptions href=\"https://your-subdomain.recurly.com/v2/invoices/1007/subscriptions\"/>\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    <uuid>37c0057d2f641f4e2fcbda4b5b833633</uuid>\n    <state>paid</state>\n    <invoice_number_prefix/>\n    <invoice_number type=\"integer\">1007</invoice_number>\n    <po_number nil=\"nil\"/>\n    <vat_number nil=\"nil\"/>\n    <subtotal_in_cents type=\"integer\">2000</subtotal_in_cents>\n    <discount_in_cents type=\"integer\">0</discount_in_cents>\n    <due_on type=\"datetime\">2018-01-30T21:11:50Z</due_on>\n    <balance_in_cents type=\"integer\">0</balance_in_cents>\n    <type>charge</type>\n    <origin>purchase</origin>\n    <credit_invoices href=\"https://your-subdomain.recurly.com/v2/invoices/1325/credit_invoices\"/>\n    <refundable_total_in_cents type=\"integer\">2000</refundable_total_in_cents>\n    <credit_payments type=\"array\">\n    </credit_payments>\n    <tax_in_cents type=\"integer\">424</tax_in_cents>\n    <total_in_cents type=\"integer\">5274</total_in_cents>\n    <currency>EUR</currency>\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    <closed_at type=\"datetime\">2016-08-03T16:26:26Z</closed_at>\n    <terms_and_conditions nil=\"nil\"/>\n    <customer_notes nil=\"nil\"/>\n    <tax_type>usst</tax_type>\n    <tax_region>CA</tax_region>\n    <tax_rate type=\"float\">0.0875</tax_rate>\n    <net_terms type=\"integer\">0</net_terms>\n    <collection_method>automatic</collection_method>\n    <redemptions href=\"https://your-subdomain.recurly.com/v2/invoices/1007/redemptions\"/>\n    <line_items type=\"array\">\n      <adjustment href=\"https://your-subdomain.recurly.com/v2/adjustments/37c0057d2a3ace0c3f3d674ae89fdabd\" 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>37c0057d2a3ace0c3f3d674ae89fdabd</uuid>\n        <state>invoiced</state>\n        <description>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        <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        <shipping_address>\n          <first_name>Lon</first_name>\n          <last_name>Doner</last_name>\n          <address1>400 Alabama St</address1>\n          <address2></address2>\n          <city>San Francisco</city>\n          <state>CA</state>\n          <zip>94110</zip>\n          <country>US</country>\n          <phone></phone>\n          <nickname>home</nickname>\n        </shipping_address>\n        <start_date type=\"datetime\">2016-08-03T16:26:26Z</start_date>\n        <end_date nil=\"nil\"/>\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>\n      <!-- Continued... -->\n    </line_items>\n    <transactions type=\"array\">\n      <!-- Detail. -->\n    </transactions>\n    <a name=\"refund\" href=\"https://your-subdomain.recurly.com/v2/invoices/1007/refund\" method=\"post\"/>\n  </charge_invoice>\n  <credit_invoices type=\"array\">\n  </credit_invoices>\n</invoice_collection>","language":"xml","status":200}]},"settings":"","examples":{"codes":[{"code":"<purchase>\n  <collection_method>automatic</collection_method>\n  <currency>USD</currency>\n  <customer_notes>Some notes for the customer.</customer_notes>\n  <terms_and_conditions>Our company terms and conditions.</terms_and_conditions>\n  <vat_reverse_charge_notes>Vat reverse charge notes.</vat_reverse_charge_notes>\n  <account>\n    <account_code>c442b36c-c64f-41d7-b8e1-9c04e7a6ff82</account_code>\n    <shipping_addresses>\n      <shipping_address>\n        <first_name>Lon</first_name>\n        <last_name>Doner</last_name>        \n        <address1>221B Baker St.</address1>\n        <city>London</city>\n        <state></state>\n        <zip>W1K 6AH</zip>\n        <country>GB</country>\n        <nickname>Home</nickname>\n      </shipping_address>\n    </shipping_addresses>\n    <billing_info>\n      <address1>400 Alabama St</address1>\n      <city>San Francisco</city>\n      <country>US</country>\n      <first_name>Benjamin</first_name>\n      <last_name>Du Monde</last_name>\n      <month>12</month>\n      <number>4111-1111-1111-1111</number>\n      <state>CA</state>\n      <year>2019</year>\n      <zip>94110</zip>\n    </billing_info>\n  </account>\n  <adjustments>\n    <adjustment>\n      <product_code>4549449c-5870-4845-b672-1d07f15e87dd</product_code>\n      <quantity>1</quantity>\n      <revenue_schedule_type>at_invoice</revenue_schedule_type>\n      <unit_amount_in_cents>1000</unit_amount_in_cents>\n      <description>Description of this adjustment</description>\n    </adjustment>\n  </adjustments>\n  <subscriptions>\n    <subscription>\n      <plan_code>plan1</plan_code>\n    </subscription>\n  </subscriptions>\n  <coupon_codes>\n  \t<coupon_code>coupon1</coupon_code>\n    <coupon_code>coupon2</coupon_code>\n  </coupon_codes>\n  <gift_card>\n    <redemption_code>ABC1234</redemption_code>\n  </gift_card>\n</purchase>","language":"xml"},{"code":"require 'securerandom'\n\npurchase = Recurly::Purchase.new({\n  currency: 'USD',\n  collection_method: :automatic,\n  account: {\n    account_code: SecureRandom.uuid,\n    billing_info: {\n      first_name: 'Benjamin',\n      last_name: 'Du Monde',\n      address1: '400 Alabama St',\n      city: 'San Francisco',\n      state: 'CA',\n      zip: '94110',\n      country: 'US',\n      number: '4111-1111-1111-1111',\n      month: 12,\n      year: 2019,\n    },\n    shipping_addresses: [\n      {\n        first_name: 'Lon',\n        last_name: 'Dorner',\n        address1: '400 Alabama St',\n        city: 'San Francisco',\n        state: 'CA',\n        zip: '94110',\n        country: 'US',\n        nickname: 'home',\n      }\n    ]\n  },\n  subscriptions: [\n    {\n      plan_code: \"gold\",\n    }\n  ],\n  adjustments: [\n    {product_code: SecureRandom.uuid, unit_amount_in_cents: 1_000, quantity: 1, revenue_schedule_type: :at_invoice},\n  ],\n  coupon_codes: [\n    \"COUPON123\",\n    \"COUPON345\",\n  ],\n  gift_card: {\n    redemption_code: \"BC3749AB38371F273\"\n  }\n})\n\nbegin\n  collection = Recurly::Purchase.invoice!(purchase)\n  puts collection.inspect\nrescue Recurly::Resource::Invalid => e\n  puts e.inspect\n  # Invalid data\nrescue Recurly::Transaction::Error => e\n  puts e.inspect\n  # Transaction error\n  # e.transaction\n  # e.transaction_error_code\nend\n","language":"ruby"},{"code":"<?php\n\n$purchase = new Recurly_Purchase();\n$purchase->currency = 'USD';\n$purchase->collection_method = 'automatic';\n$purchase->account = new Recurly_Account();\n$purchase->account->account_code = 'aba9209a-aa61-4790-8e61-0a2692435fee';\n$purchase->account->email = \"verena@example.com\";\n$purchase->account->first_name = \"Benjamin\";\n$purchase->account->last_name = \"Du Monde\";\n$purchase->account->address->phone = \"555-555-5555\";\n$purchase->account->address->address1 = \"123 Main St.\";\n$purchase->account->address->city = \"San Francisco\";\n$purchase->account->address->state = \"CA\";\n$purchase->account->address->zip = \"94110\";\n$purchase->account->address->country = \"US\";\n\n$billing_info = new Recurly_BillingInfo();\n$billing_info->number = '4111-1111-1111-1111';\n$billing_info->month = 12;\n$billing_info->year = 2019;\n$billing_info->verification_value = '123';\n$billing_info->address1 = '400 Alabama St';\n$billing_info->city = 'San Francisco';\n$billing_info->state = 'CA';\n$billing_info->country = 'US';\n$billing_info->zip = '94110';\n\n$purchase->account->billing_info = $billing_info;\n\n$shipping_address = new Recurly_ShippingAddress();\n$shipping_address->first_name = 'Lon';\n$shipping_address->last_name = 'Dorner';\n$shipping_address->address1 = '400 Dolores St';\n$shipping_address->city = 'San Francisco';\n$shipping_address->state = 'CA';\n$shipping_address->country = 'US';\n$shipping_address->zip = '94110';\n$shipping_address->nickname = 'Home';\n\n$purchase->account->shipping_addresses = array($shipping_address);\n\n$adjustment = new Recurly_Adjustment();\n$adjustment->unit_amount_in_cents = 1000;\n$adjustment->quantity = 1;\n\n$purchase->adjustments = array($adjustment);\n\n$subscription = new Recurly_Subscription();\n$subscription->plan_code = 'pp';\n\n$purchase->subscriptions = array($subscription);\n\n$purchase->coupon_codes = array('couponcode123', 'rqw311ofo6');\n\n$gift_card = new Recurly_GiftCard();\n$gift_card->redemption_code = \"FCJ7GEY4HO8WR16Q\";\n$purchase->gift_card = $gift_card;\n\n// Create an invoice collection\ntry {\n  $collection = Recurly_Purchase::invoice($purchase);\n} catch (Recurly_ValidationError $e) {\n  // You can get an idea why a purchase failed looking at these objects:\n  var_dump($e->errors->transaction_error);  // Recurly_TransactionError\n  var_dump($e->errors->transaction);   // Recurly_Transaction\n} \n","language":"php"},{"code":"var accountCode = \"benjamin-du-monde\";\nvar currency = \"USD\";\nvar planCode = \"surveillance-pro\";\nvar couponCode = \"surveillance-podcast-promo\";\nvar giftCardRedemptionCode = \"8Z5VE6IRMWJDHU4P\";\n\n// We can create a purchase object from an account code or an Account object (first argument).\n// Use the Account object when you want create a new account. This works similar to Subscription.\nvar purchase = new Purchase(accountCode, currency);\n\nvar shipAddr = new ShippingAddress();\nshipAddr.Address1 = \"400 Alabama St\";\nshipAddr.City = \"San Francisco\";\nshipAddr.State = \"CA\";\nshipAddr.Country = \"US\";\nshipAddr.Zip = \"94110\";\nshipAddr.FirstName = \"Lon\";\nshipAddr.LastName = \"Dorner\";\nshipAddr.Nickname = \"home\";\npurchase.Account.ShippingAddresses.Add(shipAddr);\n\n// Add multiple adjustments (optional if subscription[s] included)\npurchase.Adjustments.Add(new Adjustment(4000, \"HD Camera\", 5));\npurchase.Adjustments.Add(new Adjustment(1000, \"Motion Sensor\", 10));\n\n// Add multiple subscriptions (optional if adjustment[s] included)\npurchase.Subscriptions.Add(new Subscription(planCode));\n\n// Add multiple coupon codes the customer may have (optional)\npurchase.CouponCodes.Add(couponCode);\n\n// Redeem a gift card with this purchase if the customer has redemption code (optional)\npurchase.GiftCardRedemptionCode = giftCardRedemptionCode;\n\n// For manual invoicing\n// purchase.CollectionMethod = Invoice.Collection.Manual;\n// purchase.NetTerms = 30;\n\n// Executes the purchase and transactions\nvar collection = Purchase.Invoice(purchase);","language":"csharp"},{"code":"purchase = recurly.Purchase(\n  currency = 'USD',\n  account = recurly.Account(\n    account_code = 'account-code-123',\n    billing_info = recurly.BillingInfo(\n        first_name = 'Benjamin',\n        last_name = 'DuMonde',\n        number = '4111-1111-1111-1111',\n        verification_value = '123',\n        month = 11,\n        year = 2020,\n        address1 = '123 Main St',\n        city = 'New Orleans',\n        state = 'LA',\n        zip = '70114',\n        country = 'US',\n    ),\n    shipping_addresses = [\n      recurly.ShippingAddress(\n          first_name = 'Lon',\n          last_name = 'Dorner',\n          address1 = '400 Alabama St',\n          city = 'San Francisco',\n          state = 'CA',\n          zip = '94110',\n          country = 'US',\n          nickname = 'home'\n      )\n    ]\n  ),\n  subscriptions = [\n      recurly.Subscription(plan_code = 'gold')\n  ],\n  adjustments = [\n      recurly.Adjustment(unit_amount_in_cents=1000, description='Item 1',\n                         quantity=1),\n      recurly.Adjustment(unit_amount_in_cents=2000, description='Item 2',\n                         quantity=2),\n  ]\n)\n\ncollection = purchase.invoice()\nprint(collection)","language":"python"}]},"auth":"required","params":[{"_id":"591b66df7d2cb40f00d471d6","ref":"","in":"body","required":true,"desc":"An account object. This can be an existing account or a new account. If using a new account and adding shipping addresses, the last shipping address in the list will apply to every subscription and adjustment in the purchase.","default":"","type":"object","name":"account"},{"_id":"591b66df7d2cb40f00d471d5","ref":"","in":"body","required":true,"desc":"This should be a list of Adjustment objects. Required if there are no subscriptions.","default":"","type":"array_object","name":"adjustments"},{"_id":"591b66df7d2cb40f00d471d4","ref":"","in":"body","required":false,"desc":"The collection method for the invoice (`automatic` or `manual`).","default":"","type":"string","name":"collection_method"},{"_id":"591b66df7d2cb40f00d471d3","ref":"","in":"body","required":true,"desc":"The 3 letter currency code for the adjustments.","default":"","type":"string","name":"currency"},{"_id":"591b66df7d2cb40f00d471d2","ref":"","in":"body","required":false,"desc":"A PO number for the resulting invoice. Manual invoicing must be enabled on your site to use po_number with this endpoint","default":"","type":"string","name":"po_number"},{"_id":"591b66df7d2cb40f00d471d1","ref":"","in":"body","required":false,"desc":"The net terms for the invoice","default":"","type":"int","name":"net_terms"},{"_id":"595575d48613d9002bc540c1","ref":"","in":"body","required":false,"desc":"A gift card with a redemption code to apply to this purchase","default":"","type":"object","name":"gift_card"},{"_id":"595575d48613d9002bc540c0","ref":"","in":"body","required":false,"desc":"A list of coupon codes to apply to this purchase","default":"","type":"array_string","name":"coupon_codes"},{"_id":"595575d48613d9002bc540bf","ref":"","in":"body","required":true,"desc":"A list of Subscriptions to invoice in this purchase. Required if there are no adjustments.","default":"","type":"array_object","name":"subscriptions"},{"_id":"59d696a76d3f930010332fd4","ref":"","in":"body","required":false,"desc":"Optional notes to show customer on the invoice. This will default to the Customer Notes text specified on the Invoice Settings page in your Recurly admin. Custom notes made on an invoice for a one time charge will not carry over to subsequent invoices.","default":"","type":"string","name":"customer_notes"},{"_id":"59d696a76d3f930010332fd3","ref":"","in":"body","required":false,"desc":"Optional terms and conditions to show customer on the invoice. This will default to the Terms and Conditions text specified on the Invoice Settings page in your Recurly admin. Custom notes will stay with a subscription on all renewals.","default":"","type":"string","name":"terms_and_conditions"},{"_id":"59d696a76d3f930010332fd2","ref":"","in":"body","required":false,"desc":"Optional VAT reverse charge notes to show the customer on the invoice. Only appears if you have EU VAT enabled or are using your own Avalara AvaTax account and the customer is in the EU, has a VAT number, and is in a different country than your own. This will default to the VAT Reverse Charge Notes text specified on the Tax Settings page in your Recurly admin, unless custom notes were created with the original subscription. Custom notes will stay with a subscription on all renewals.","default":"","type":"string","name":"vat_reverse_charge_notes"},{"_id":"5abbd2c152432700129dca5a","ref":"","in":"body","required":false,"desc":"All subscriptions and adjustments on the purchase will use this shipping address unless they specify one of their own. Any subscriptions for which this address might apply will also use it in future renewals unless changed or removed. Cannot be used if a new shipping address is created at the account level.","default":"","type":"long","name":"shipping_address_id"},{"_id":"5bf59cdaa46f07003f486d47","ref":"","in":"body","required":false,"desc":"An alphanumeric code shown per gateway on your site's payment gateways page. Set this code to ensure that a given purchase targets a given gateway.","default":"","type":"string","name":"gateway_code"}],"url":"/purchases"},"isReference":true,"order":0,"body":"","excerpt":"A purchase is a checkout containing at least one or more subscriptions or one-time charges (adjustments) and supports both coupon and gift card redemptions. All items purchased will be on one invoice and paid for with one transaction. A purchase is only a request data type and is not persistent in Recurly and an invoice collection will be the returned type. If you plan to use a shipping address(es) for a purchase, please see https://docs.recurly.com/docs/shipping-address-per-line-item","slug":"create-purchase","type":"post","title":"Create Purchase","__v":23,"childrenPages":[]}

{"_id":"5c0fed024d9964002ee38c51","category":"5c0fed024d9964002ee38c01","user":"55957fd09b8d0a25005a7d30","project":"555fbba928249c1900618a82","parentDoc":null,"version":"5c0fed024d9964002ee38cbb","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-05-17T16:39:29.580Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"<purchase>\n  <collection_method>automatic</collection_method>\n  <currency>USD</currency>\n  <customer_notes>Some notes for the customer.</customer_notes>\n  <terms_and_conditions>Our company terms and conditions.</terms_and_conditions>\n  <vat_reverse_charge_notes>Vat reverse charge notes.</vat_reverse_charge_notes>\n  <account>\n    <account_code>c442b36c-c64f-41d7-b8e1-9c04e7a6ff82</account_code>\n    <shipping_addresses>\n      <shipping_address>\n        <first_name>Lon</first_name>\n        <last_name>Doner</last_name>\n        <address1>221B Baker St.</address1>\n        <city>London</city>\n        <state></state>\n        <zip>W1K 6AH</zip>\n        <country>GB</country>\n        <nickname>Home</nickname>\n      </shipping_address>\n    </shipping_addresses>\n    <billing_info>\n      <address1>400 Alabama St</address1>\n      <city>San Francisco</city>\n      <country>US</country>\n      <first_name>Benjamin</first_name>\n      <last_name>Du Monde</last_name>\n      <month>12</month>\n      <number>4111-1111-1111-1111</number>\n      <state>CA</state>\n      <year>2019</year>\n      <zip>94110</zip>\n    </billing_info>\n  </account>\n  <adjustments>\n    <adjustment>\n      <product_code>4549449c-5870-4845-b672-1d07f15e87dd</product_code>\n      <quantity>1</quantity>\n      <revenue_schedule_type>at_invoice</revenue_schedule_type>\n      <unit_amount_in_cents>1000</unit_amount_in_cents>\n      <description>Description of this adjustment</description>\n    </adjustment>\n  </adjustments>\n  <subscriptions>\n    <subscription>\n      <plan_code>plan1</plan_code>\n    </subscription>\n  </subscriptions>\n  <coupon_codes>\n  \t<coupon_code>coupon1</coupon_code>\n    <coupon_code>coupon2</coupon_code>\n  </coupon_codes>\n  <gift_card>\n    <redemption_code>ABC1234</redemption_code>\n  </gift_card>\n</purchase>","language":"xml"},{"code":"require 'securerandom'\n\npurchase = Recurly::Purchase.new({\n  currency: 'USD',\n  collection_method: :automatic,\n  account: {\n    account_code: SecureRandom.uuid,\n    billing_info: {\n      first_name: 'Benjamin',\n      last_name: 'Du Monde',\n      address1: '400 Alabama St',\n      city: 'San Francisco',\n      state: 'CA',\n      zip: '94110',\n      country: 'US',\n      number: '4111-1111-1111-1111',\n      month: 12,\n      year: 2019,\n    },\n    shipping_addresses: [\n      {\n        first_name: 'Lon',\n        last_name: 'Dorner',\n        address1: '400 Alabama St',\n        city: 'San Francisco',\n        state: 'CA',\n        zip: '94110',\n        country: 'US',\n        nickname: 'home',\n      }\n    ]\n  },\n  subscriptions: [\n    {\n      plan_code: \"gold\",\n    }\n  ],\n  adjustments: [\n    {product_code: SecureRandom.uuid, unit_amount_in_cents: 1_000, quantity: 1, revenue_schedule_type: :at_invoice},\n  ],\n  coupon_codes: [\n    \"COUPON123\",\n    \"COUPON345\",\n  ],\n  gift_card: {\n    redemption_code: \"BC3749AB38371F273\"\n  }\n})\n\nbegin\n  preview_collection = Recurly::Purchase.preview!(purchase)\n  puts preview_collection.inspect\nrescue Recurly::Resource::Invalid => e\n  puts e.inspect\n  # Invalid data\nend","language":"ruby"},{"code":"<?php\n\n$purchase = new Recurly_Purchase();\n$purchase->currency = 'USD';\n$purchase->collection_method = 'automatic';\n$purchase->account = new Recurly_Account();\n$purchase->account->account_code = 'aba9209a-aa61-4790-8e61-0a2692435fee';\n$purchase->account->email = \"verena@example.com\";\n$purchase->account->first_name = \"Benjamin\";\n$purchase->account->last_name = \"Du Monde\";\n$purchase->account->address->phone = \"555-555-5555\";\n$purchase->account->address->address1 = \"123 Main St.\";\n$purchase->account->address->city = \"San Francisco\";\n$purchase->account->address->state = \"CA\";\n$purchase->account->address->zip = \"94110\";\n$purchase->account->address->country = \"US\";\n\n$billing_info = new Recurly_BillingInfo();\n$billing_info->number = '4111-1111-1111-1111';\n$billing_info->month = 12;\n$billing_info->year = 2019;\n$billing_info->verification_value = '123';\n$billing_info->address1 = '400 Alabama St';\n$billing_info->city = 'San Francisco';\n$billing_info->state = 'CA';\n$billing_info->country = 'US';\n$billing_info->zip = '94110';\n\n$purchase->account->billing_info = $billing_info;\n\n$shipping_address = new Recurly_ShippingAddress();\n$shipping_address->first_name = 'Lon';\n$shipping_address->last_name = 'Dorner';\n$shipping_address->address1 = '400 Dolores St';\n$shipping_address->city = 'San Francisco';\n$shipping_address->state = 'CA';\n$shipping_address->country = 'US';\n$shipping_address->zip = '94110';\n$shipping_address->nickname = 'Home';\n\n$purchase->account->shipping_addresses = array($shipping_address);\n\n$adjustment = new Recurly_Adjustment();\n$adjustment->unit_amount_in_cents = 1000;\n$adjustment->quantity = 1;\n\n$purchase->adjustments = array($adjustment);\n\n$subscription = new Recurly_Subscription();\n$subscription->plan_code = 'pp';\n\n$purchase->subscriptions = array($subscription);\n\n$purchase->coupon_codes = array('couponcode123', 'rqw311ofo6');\n\n$gift_card = new Recurly_GiftCard();\n$gift_card->redemption_code = \"FCJ7GEY4HO8WR16Q\";\n$purchase->gift_card = $gift_card;\n\n// Create a preview invoice collection\ntry {\n  $previewCollection = Recurly_Purchase::preview($purchase);\n} catch (Recurly_ValidationError $e) {\n  // You can get an idea why a purchase failed looking at these objects:\n  var_dump($e);\n} ","language":"php"},{"code":"var accountCode = \"benjamin-du-monde\";\nvar currency = \"USD\";\nvar planCode = \"surveillance-pro\";\nvar couponCode = \"surveillance-podcast-promo\";\nvar giftCardRedemptionCode = \"8Z5VE6IRMWJDHU4P\";\n\n// We can create a purchase object from an account code or an Account object (first argument).\n// Use the Account object when you want create a new account. This works similar to Subscription.\nvar purchase = new Purchase(accountCode, currency);\n\nvar shipAddr = new ShippingAddress();\nshipAddr.Address1 = \"400 Alabama St\";\nshipAddr.City = \"San Francisco\";\nshipAddr.State = \"CA\";\nshipAddr.Country = \"US\";\nshipAddr.Zip = \"94110\";\nshipAddr.FirstName = \"Lon\";\nshipAddr.LastName = \"Dorner\";\nshipAddr.Nickname = \"home\";\npurchase.Account.ShippingAddresses.Add(shipAddr);\n\n// Add multiple adjustments (optional if subscription[s] included)\npurchase.Adjustments.Add(new Adjustment(4000, \"HD Camera\", 5));\npurchase.Adjustments.Add(new Adjustment(1000, \"Motion Sensor\", 10));\n\n// Add multiple subscriptions (optional if adjustment[s] included)\npurchase.Subscriptions.Add(new Subscription(planCode));\n\n// Add multiple coupon codes the customer may have (optional)\npurchase.CouponCodes.Add(couponCode);\n\n// Redeem a gift card with this purchase if the customer has redemption code (optional)\npurchase.GiftCardRedemptionCode = giftCardRedemptionCode;\n\n// For manual invoicing\n// purchase.CollectionMethod = Invoice.Collection.Manual;\n// purchase.NetTerms = 30;\n\n// Previewing allows us to run all calculations and validations without running the\n// transactions yet. This allows us to check the information and show the customer\n// the the detailed invoices before they confirm the purchase.\nvar previewCollection = Purchase.Preview(purchase);","language":"csharp"},{"code":"purchase = recurly.Purchase(\n  currency = 'USD',\n  account = recurly.Account(\n    account_code = 'account-code-123',\n    billing_info = recurly.BillingInfo(\n        first_name = 'Benjamin',\n        last_name = 'DuMonde',\n        number = '4111-1111-1111-1111',\n        verification_value = '123',\n        month = 11,\n        year = 2020,\n        address1 = '123 Main St',\n        city = 'New Orleans',\n        state = 'LA',\n        zip = '70114',\n        country = 'US',\n    ),\n    shipping_addresses = [\n      recurly.ShippingAddress(\n          first_name = 'Lon',\n          last_name = 'Dorner',\n          address1 = '400 Alabama St',\n          city = 'San Francisco',\n          state = 'CA',\n          zip = '94110',\n          country = 'US',\n          nickname = 'home'\n      )\n    ]\n  ),\n  subscriptions = [\n      recurly.Subscription(plan_code = 'gold')\n  ],\n  adjustments = [\n      recurly.Adjustment(unit_amount_in_cents=1000, description='Item 1',\n                         quantity=1),\n      recurly.Adjustment(unit_amount_in_cents=2000, description='Item 2',\n                         quantity=2),\n  ]\n)\n\npreview_collection = purchase.preview()\nprint(preview_collection)","language":"python"}]},"method":"post","results":{"codes":[{"name":"","code":"<invoice_collection>\n  <charge_invoice>\n    <account href=\"https://your-subdomain.recurly.com/v2/accounts/1\"/>\n    <subscriptions href=\"https://your-subdomain.recurly.com/v2/invoices/1007/subscriptions\"/>\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    <shipping_address>\n      <first_name>Lon</first_name>\n      <last_name>Doner</last_name>\n      <address1>221B Baker St.</address1>\n      <address2></address2>\n      <city>London</city>\n      <state></state>\n      <zip>W1K 6AH</zip>\n      <country>GB</country>\n      <phone></phone>\n    </shipping_address>\n    <uuid>37c0057d2f641f4e2fcbda4b5b833633</uuid>\n    <state>paid</state>\n    <invoice_number_prefix/>\n    <invoice_number type=\"integer\">1007</invoice_number>\n    <po_number nil=\"nil\"/>\n    <vat_number nil=\"nil\"/>\n    <subtotal_in_cents type=\"integer\">2000</subtotal_in_cents>\n    <discount_in_cents type=\"integer\">0</discount_in_cents>\n    <due_on type=\"datetime\">2018-01-30T21:11:50Z</due_on>\n    <balance_in_cents type=\"integer\">0</balance_in_cents>\n    <type>charge</type>\n    <origin>purchase</origin>\n    <credit_invoices href=\"https://your-subdomain.recurly.com/v2/invoices/1325/credit_invoices\"/>\n    <refundable_total_in_cents type=\"integer\">2000</refundable_total_in_cents>\n    <credit_payments type=\"array\">\n    </credit_payments>\n    <tax_in_cents type=\"integer\">424</tax_in_cents>\n    <total_in_cents type=\"integer\">5274</total_in_cents>\n    <currency>EUR</currency>\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    <closed_at type=\"datetime\">2016-08-03T16:26:26Z</closed_at>\n    <terms_and_conditions nil=\"nil\"/>\n    <customer_notes nil=\"nil\"/>\n    <tax_type>usst</tax_type>\n    <tax_region>CA</tax_region>\n    <tax_rate type=\"float\">0.0875</tax_rate>\n    <net_terms type=\"integer\">0</net_terms>\n    <collection_method>automatic</collection_method>\n    <redemptions href=\"https://your-subdomain.recurly.com/v2/invoices/1007/redemptions\"/>\n    <line_items type=\"array\">\n      <adjustment href=\"https://your-subdomain.recurly.com/v2/adjustments/37c0057d2a3ace0c3f3d674ae89fdabd\" 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>37c0057d2a3ace0c3f3d674ae89fdabd</uuid>\n        <state>invoiced</state>\n        <description>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        <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        <start_date type=\"datetime\">2016-08-03T16:26:26Z</start_date>\n        <end_date nil=\"nil\"/>\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>\n      <!-- Continued... -->\n    </line_items>\n    <transactions type=\"array\">\n      <!-- Detail. -->\n    </transactions>\n    <a name=\"refund\" href=\"https://your-subdomain.recurly.com/v2/invoices/1007/refund\" method=\"post\"/>\n  </charge_invoice>\n  <credit_invoices type=\"array\">\n  </credit_invoices>\n</invoice_collection>","language":"xml","status":200}]},"settings":"","auth":"required","params":[{"_id":"591b66df7d2cb40f00d471d6","ref":"","in":"body","required":true,"desc":"An account object. This can be an existing account or a new account. If using a new account and adding shipping addresses, the last shipping address in the list will apply to every subscription and adjustment in the purchase.","default":"","type":"object","name":"account"},{"_id":"591b66df7d2cb40f00d471d5","ref":"","in":"body","required":true,"desc":"This should be a list of Adjustment objects. Required if there are no subscriptions.","default":"","type":"array_object","name":"adjustments"},{"_id":"591b66df7d2cb40f00d471d4","ref":"","in":"body","required":false,"desc":"The collection method for the invoice (`automatic` or `manual`).","default":"","type":"string","name":"collection_method"},{"_id":"591b66df7d2cb40f00d471d3","ref":"","in":"body","required":false,"desc":"The 3 letter currency code for the adjustments.","default":"","type":"string","name":"currency"},{"_id":"591b66df7d2cb40f00d471d2","ref":"","in":"body","required":false,"desc":"A po number for the resulting invoice.","default":"","type":"string","name":"po_number"},{"_id":"591b66df7d2cb40f00d471d1","ref":"","in":"body","required":false,"desc":"The net terms for the invoice","default":"","type":"int","name":"net_terms"},{"_id":"5955762bba6cff002966ae31","ref":"","in":"body","required":false,"desc":"A gift card with a redemption code to apply to this purchase","default":"","type":"object","name":"gift_card"},{"_id":"5955762bba6cff002966ae30","ref":"","in":"body","required":false,"desc":"A list of coupon codes to apply to this purchase","default":"","type":"array_string","name":"coupon_codes"},{"_id":"5955762bba6cff002966ae2f","ref":"","in":"body","required":true,"desc":"A list of Subscriptions to invoice in this purchase. Required if there are no adjustments.","default":"","type":"array_object","name":"subscriptions"},{"_id":"59d699316d3f930010333002","ref":"","in":"body","required":false,"desc":"Optional notes to show customer on the invoice. This will default to the Customer Notes text specified on the Invoice Settings page in your Recurly admin. Custom notes made on an invoice for a one time charge will not carry over to subsequent invoices.","default":"","type":"string","name":"customer_notes"},{"_id":"59d699316d3f930010333001","ref":"","in":"body","required":false,"desc":"Optional terms and conditions to show customer on the invoice. This will default to the Terms and Conditions text specified on the Invoice Settings page in your Recurly admin. Custom notes will stay with a subscription on all renewals.","default":"","type":"string","name":"terms_and_conditions"},{"_id":"59d699316d3f930010333000","ref":"","in":"body","required":false,"desc":"Optional VAT reverse charge notes to show the customer on the invoice. Only appears if you have EU VAT enabled or are using your own Avalara AvaTax account and the customer is in the EU, has a VAT number, and is in a different country than your own. This will default to the VAT Reverse Charge Notes text specified on the Tax Settings page in your Recurly admin, unless custom notes were created with the original subscription. Custom notes will stay with a subscription on all renewals.","default":"","type":"string","name":"vat_reverse_charge_notes"},{"_id":"5abbd2e452432700129dca5b","ref":"","in":"body","required":false,"desc":"All subscriptions and adjustments on the purchase will use this shipping address unless they specify one of their own. Any subscriptions for which this address might apply will also use it in future renewals unless changed or removed. Cannot be used if a new shipping address is created at the account level.","default":"","type":"long","name":"shipping_address_id"}],"url":"/purchases/preview"},"isReference":true,"order":1,"body":"","excerpt":"A purchase is a hybrid checkout containing at least one or more subscriptions or one-time charges (adjustments) and supports both coupon and gift card redemptions. All items purchased will be on one invoice and paid for with one transaction. A purchase is only a request data type and is not persistent in Recurly and an invoice collection will be the returned type.\n\nPOSTing to the preview endpoint runs the validations and creates a preview invoice, but does not run the transactions.","slug":"preview-purchase","type":"post","title":"Preview Purchase","__v":14,"childrenPages":[]}