{"__v":0,"_id":"57083050cc231e1700927902","initVersion":{"_id":"56fd7e6b5a08190e00084f45","version":"2.1"},"project":"555fbba928249c1900618a82","user":{"_id":"5581f6648625220d00429ef6","username":"","name":"Rafi Yagudin"},"hidden":false,"createdAt":"2016-04-08T22:27:28.411Z","fullscreen":false,"htmlmode":false,"html":"","body":"Our release notes outline changes between various API versions to help our merchants better integrate with our API service.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"v2.4 Release Notes\"\n}\n[/block]\nThis release adds three new features:\n\n- Gift cards\n- Shipping addresses\n- Marketing/CRM data\n\nRoute changes:\n\n- Added `POST /v2/gift_cards`\n- Added `POST /v2/gift_cards/preview`\n- Added `POST /v2/gift_cards/:redemption_code/redeem`\n- Added `GET /v2/gift_cards`\n- Added `GET /v2/gift_cards/:id`\n- Added `GET /v2/accounts/:account_code/acquisition`\n- Added `GET /v2/accounts/:account_code/shipping_addresses`\n- Added `GET /v2/accounts/:account_code/shipping_addresses/:shipping_address_id`\n- Added `GET /v2/accounts/:account_code/shipping_addresses/:shipping_address_id/subscriptions`\n- Added `POST /v2/accounts/:account_code/shipping_addresses`\n- Added `PUT /v2/accounts/:account_code/shipping_addresses/:shipping_address_id`\n- Added `DELETE /v2/accounts/:account_code/shipping_addresses/:shipping_address_id`\n- Removed `GET /v2/accounts/:account_code/subscription`\n- Removed `POST /v2/accounts/:account_code/subscription`\n- Removed `PUT /v2/accounts/:account_code/subscription`\n- Removed `DELETE /v2/accounts/:account_code/subscription`\n- Added `GET /v2/export_dates`\n- Added `GET /v2/export_dates/:date/export_files`\n- Added `GET /v2/export_dates/:date/export_files/:file`\n\nRequest and Response Changes:\n\n- Changed Account POST request:\n  - Added `<shipping_addresses>` element.\n- Changed Account response:\n  - Added `<account_acquisition>` link element.\n  - Added `<shipping_addresses>` link element.\n- Changed Subscription request:\n  - Added `<shipping_address>` element.\n  - Added `<shipping_address_id>` element.\n- Changed Subscription response:\n  - Added `<shipping_address>` link element.\n- Changed Transaction and BillingInfo responses:\n  - Added `<risk_rules_triggered>` element to `<fraud_info>`\n- Added Account Acquisition request and response.\n- Changed Invoice response:\n  - Added `<shipping_address>` element.\n- Changed Address response:\n  - Added `<name>` element.\n- Added ExportDates, ExportDate, ExportFiles, ExportsFile responses.\n- Changed Subscription Create and Preview POST requests:\n  - Create route: `POST /v2/subscriptions`\n  - Preview route: `POST /v2/subscriptions/preview`\n  - Added optional `<gift_card>` block element for redeeming gift\n    card as part of new subscription signup.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"v2.3 Release Notes\"\n}\n[/block]\nThis release added:\n\n* Revenue schedules to several objects to enable Revenue Recognition.\n* Sorting and date filtering to listing endpoints, see [Pagination](doc:pagination) for details.\n* The ability to check an account's balance, see [Lookup Account Balance](doc:lookup-account-balance) for details.\n\nDetailed listing of changes to requests and responses:\n\n- Changed Account response:\n  - Added `<account_balance>` link element.\n- Changed Adjustment response:\n  - Added `<revenue_schedule_type>` element.\n- Changed Plan response:\n  - Added `<revenue_schedule_type>` element.\n  - Added `<setup_fee_revenue_schedule_type>` element.\n- Changed Plan Add-On response:\n  - Added `<revenue_schedule_type>` element.\n- Changed Subscription response:\n  - Added `<revenue_schedule_type>` element.\n- Changed Subscription Add-On response:\n  - Added `<revenue_schedule_type>` element.\n- Changed Transaction response:\n  - Added `<original_transaction>` link element.\n- Added pagination options:\n  - Added `sort` option: accepts `created_at`/`updated_at`, defaults to `created_at`.\n  - Added `order` option: accepts `desc`/`asc`, defaults to `desc`.\n  - Added `begin_time`/`end_time` options: accepts an ISO 8601 date or date and time.\n\nA complete list of changes for all versions is available on the [API Release Notes](https://dev.recurly.com/page/api-release-notes) page.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"v2.2 Release Notes\"\n}\n[/block]\nThis release focused on supporting our new [Usage-Based Billing](https://docs.recurly.com/docs/usage-based-billing) feature.\n\nAdded endpoints for managing Measured Units:\n- [List Measured Units](doc:list-measured-units)\n- [Create Measured Unit](doc:create-measured-unit)\n- [Lookup Measured Unit](doc:lookup-measured-unit)\n- [Update Measured Unit](doc:update-measured-unit)\n- [Delete Measured Unit](doc:delete-measured-unit)\n\nAdded endpoints for managing Usage-Based Billing:\n- [List a Subscription Add-On's Usage](doc:list-add-ons-usage)\n- [Log Usage](doc:log-usage)\n- [Lookup Usage Record](doc:lookup-usage-record)\n- [Update Usage Record](doc:update-usage)\n- [Delete Usage Record](doc:delete-a-usage-record)\n\nDetailed listing of changes to requests and responses:\n- Changed Account response:\n  - Added `<updated_at>` element.\n- Changed Add-On response:\n  - Added `<measured_unit>` link element.\n  - Added `<add_on_type>` element.\n  - Added `<usage_type>` element.\n  - Added `<usage_percentage>` element.\n  - Added `<updated_at>` element.\n- Changed Adjustment response:\n  - Added `<updated_at>` element.\n- Changed Coupon response:\n  - Added `<updated_at>` element.\n- Changed Invoice response:\n  - Added `<updated_at>` element.\n- Changed Plan response:\n  - Added `<updated_at>` element.\n- Changed Redemption response:\n  - Added `<updated_at>` element.\n- Changed Subscription response:\n  - Added the following to `<subscription_add_on>`:\n    - `<add_on_type>` element.\n    - `<measured_unit>` link element.\n    - `<usage>` link element.\n    - `<unit_amount_in_cents>` element.\n  - Added `<updated_at>` element.\n- Changed Transaction response:\n  - Added `<updated_at>` element.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"v2.1 Release Notes\"\n}\n[/block]\nThis release is focused on adding better Coupon integration. \n\nAdded endpoints managing coupon redemptions:\n- [Lookup a Coupon Redemption on an Account](doc:lookup-a-coupon-redemption-on-an-account) \n- [Lookup a Coupon Redemption on an Invoice](doc:lookup-a-coupon-redemption-on-an-invoice) \n- [Lookup a Coupon Redemption on a Subscription](doc:lookup-a-coupon-redemption-on-a-subscription)\n- [Remove a Coupon Redemption from an Account](doc:remove-a-coupon-from-an-account) \n\nAdded endpoint for creating bulk coupons:\n- [Generate Unique Codes](doc:generate-unique-codes) \n\nDetailed listing of changes to requests and responses:\n- Changed Account, Invoice, and Subscription responses:\n  - Added `<redemptions>` link element.\n  - Removed `<redemption>` link, use `<redemptions>` instead.\n- Changed Coupon response:\n  - Added `<bulk_coupon>` link to unique coupon codes.\n  - Added `<redemption>` link to unique coupon codes.\n  - Added `<unique_coupon_codes>` link to bulk coupons.\n- Changed Redemption response, added `<subscription>` link element.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"v2.0 Release Notes\"\n}\n[/block]\nInitial release of 2.0.","slug":"api-release-notes","title":"API Release Notes"}

API Release Notes


Our release notes outline changes between various API versions to help our merchants better integrate with our API service. [block:api-header] { "type": "basic", "title": "v2.4 Release Notes" } [/block] This release adds three new features: - Gift cards - Shipping addresses - Marketing/CRM data Route changes: - Added `POST /v2/gift_cards` - Added `POST /v2/gift_cards/preview` - Added `POST /v2/gift_cards/:redemption_code/redeem` - Added `GET /v2/gift_cards` - Added `GET /v2/gift_cards/:id` - Added `GET /v2/accounts/:account_code/acquisition` - Added `GET /v2/accounts/:account_code/shipping_addresses` - Added `GET /v2/accounts/:account_code/shipping_addresses/:shipping_address_id` - Added `GET /v2/accounts/:account_code/shipping_addresses/:shipping_address_id/subscriptions` - Added `POST /v2/accounts/:account_code/shipping_addresses` - Added `PUT /v2/accounts/:account_code/shipping_addresses/:shipping_address_id` - Added `DELETE /v2/accounts/:account_code/shipping_addresses/:shipping_address_id` - Removed `GET /v2/accounts/:account_code/subscription` - Removed `POST /v2/accounts/:account_code/subscription` - Removed `PUT /v2/accounts/:account_code/subscription` - Removed `DELETE /v2/accounts/:account_code/subscription` - Added `GET /v2/export_dates` - Added `GET /v2/export_dates/:date/export_files` - Added `GET /v2/export_dates/:date/export_files/:file` Request and Response Changes: - Changed Account POST request: - Added `<shipping_addresses>` element. - Changed Account response: - Added `<account_acquisition>` link element. - Added `<shipping_addresses>` link element. - Changed Subscription request: - Added `<shipping_address>` element. - Added `<shipping_address_id>` element. - Changed Subscription response: - Added `<shipping_address>` link element. - Changed Transaction and BillingInfo responses: - Added `<risk_rules_triggered>` element to `<fraud_info>` - Added Account Acquisition request and response. - Changed Invoice response: - Added `<shipping_address>` element. - Changed Address response: - Added `<name>` element. - Added ExportDates, ExportDate, ExportFiles, ExportsFile responses. - Changed Subscription Create and Preview POST requests: - Create route: `POST /v2/subscriptions` - Preview route: `POST /v2/subscriptions/preview` - Added optional `<gift_card>` block element for redeeming gift card as part of new subscription signup. [block:api-header] { "type": "basic", "title": "v2.3 Release Notes" } [/block] This release added: * Revenue schedules to several objects to enable Revenue Recognition. * Sorting and date filtering to listing endpoints, see [Pagination](doc:pagination) for details. * The ability to check an account's balance, see [Lookup Account Balance](doc:lookup-account-balance) for details. Detailed listing of changes to requests and responses: - Changed Account response: - Added `<account_balance>` link element. - Changed Adjustment response: - Added `<revenue_schedule_type>` element. - Changed Plan response: - Added `<revenue_schedule_type>` element. - Added `<setup_fee_revenue_schedule_type>` element. - Changed Plan Add-On response: - Added `<revenue_schedule_type>` element. - Changed Subscription response: - Added `<revenue_schedule_type>` element. - Changed Subscription Add-On response: - Added `<revenue_schedule_type>` element. - Changed Transaction response: - Added `<original_transaction>` link element. - Added pagination options: - Added `sort` option: accepts `created_at`/`updated_at`, defaults to `created_at`. - Added `order` option: accepts `desc`/`asc`, defaults to `desc`. - Added `begin_time`/`end_time` options: accepts an ISO 8601 date or date and time. A complete list of changes for all versions is available on the [API Release Notes](https://dev.recurly.com/page/api-release-notes) page. [block:api-header] { "type": "basic", "title": "v2.2 Release Notes" } [/block] This release focused on supporting our new [Usage-Based Billing](https://docs.recurly.com/docs/usage-based-billing) feature. Added endpoints for managing Measured Units: - [List Measured Units](doc:list-measured-units) - [Create Measured Unit](doc:create-measured-unit) - [Lookup Measured Unit](doc:lookup-measured-unit) - [Update Measured Unit](doc:update-measured-unit) - [Delete Measured Unit](doc:delete-measured-unit) Added endpoints for managing Usage-Based Billing: - [List a Subscription Add-On's Usage](doc:list-add-ons-usage) - [Log Usage](doc:log-usage) - [Lookup Usage Record](doc:lookup-usage-record) - [Update Usage Record](doc:update-usage) - [Delete Usage Record](doc:delete-a-usage-record) Detailed listing of changes to requests and responses: - Changed Account response: - Added `<updated_at>` element. - Changed Add-On response: - Added `<measured_unit>` link element. - Added `<add_on_type>` element. - Added `<usage_type>` element. - Added `<usage_percentage>` element. - Added `<updated_at>` element. - Changed Adjustment response: - Added `<updated_at>` element. - Changed Coupon response: - Added `<updated_at>` element. - Changed Invoice response: - Added `<updated_at>` element. - Changed Plan response: - Added `<updated_at>` element. - Changed Redemption response: - Added `<updated_at>` element. - Changed Subscription response: - Added the following to `<subscription_add_on>`: - `<add_on_type>` element. - `<measured_unit>` link element. - `<usage>` link element. - `<unit_amount_in_cents>` element. - Added `<updated_at>` element. - Changed Transaction response: - Added `<updated_at>` element. [block:api-header] { "type": "basic", "title": "v2.1 Release Notes" } [/block] This release is focused on adding better Coupon integration. Added endpoints managing coupon redemptions: - [Lookup a Coupon Redemption on an Account](doc:lookup-a-coupon-redemption-on-an-account) - [Lookup a Coupon Redemption on an Invoice](doc:lookup-a-coupon-redemption-on-an-invoice) - [Lookup a Coupon Redemption on a Subscription](doc:lookup-a-coupon-redemption-on-a-subscription) - [Remove a Coupon Redemption from an Account](doc:remove-a-coupon-from-an-account) Added endpoint for creating bulk coupons: - [Generate Unique Codes](doc:generate-unique-codes) Detailed listing of changes to requests and responses: - Changed Account, Invoice, and Subscription responses: - Added `<redemptions>` link element. - Removed `<redemption>` link, use `<redemptions>` instead. - Changed Coupon response: - Added `<bulk_coupon>` link to unique coupon codes. - Added `<redemption>` link to unique coupon codes. - Added `<unique_coupon_codes>` link to bulk coupons. - Changed Redemption response, added `<subscription>` link element. [block:api-header] { "type": "basic", "title": "v2.0 Release Notes" } [/block] Initial release of 2.0.