{"_id":"57083050cc231e1700927902","initVersion":{"_id":"56fd7e6b5a08190e00084f45","version":"2.1"},"user":{"_id":"5581f6648625220d00429ef6","username":"","name":"Rafi Yagudin"},"project":"555fbba928249c1900618a82","__v":0,"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  \"title\": \"v2.17 Release Notes\"\n}\n[/block]\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[block:api-header]\n{\n  \"title\": \"v2.16 Release Notes\"\n}\n[/block]\nRequest and Response changes:\n\n- Changed `POST v2/purchases` request:\n  - Allow `po_number` when collection method is `automatic` and manual invoicing is enabled.\n- Changed `PUT /v2/accounts/:account_code/billing_info` request:\n  - Added support for updating billing info with a gateway code and token. Previous versions only allowed creating a new billing info, not updating existing billing info.\n- Changed `PUT /v2/accounts/:account_code/billing_info` response:\n  - Added <gateway_code> and (masked) <gateway_token> to response when updating a billing info with gateway code and token, so it maps to the request that was sent.\n[block:api-header]\n{\n  \"title\": \"v2.15 Release Notes\"\n}\n[/block]\nRequest and Response changes:\n\n- Changed `Account` response:\n  - Added <notes> href tag so client libraries have the link for listing account notes.\n- Changed `POST v2/accounts/:account_code/billing_info` request\n  - Added <card_type> String\n- Changed `POST v2/subscriptions` request when including billing info\n  - Added <card_type> String\n[block:api-header]\n{\n  \"title\": \"v2.14 Release Notes\"\n}\n[/block]\nRequest and Response changes:\n\n- Changed Subscription create request format:\n  - Added `<next_bill_date>` Datetime.\n    - description: `<first_renewal_date>` is now deprecated. Use `<next_bill_date>` instead.\n- Added `PUT /v2/invoices/:invoice_number`\n  - description: If the `Edit Invoice` feature flag is enabled, several fields on invoices are editable. This includes\n    `customer_notes`, and `terms_and_conditions`. `vat_reverse_charge_notes` can be edited only if the invoice already\n    had reverse charge notes. `po_number` is editable except for credit invoices. `name_on_account`, `first_name`,\n    `last_name`, `company`, and `phone` are editable on `address`. `address1`, `address2`, `city`, `state`, `zip` and\n    `country` on `address` are also editable, if the invoice doesn't have tax applied, and site doesn't have taxes\n    enabled. `net_terms` is editable, only for manual invoices in pending or past due states. Only the invoice and\n    address fields (as listed above) in the request will be updated; fields not present in the request will not be\n    updated, and their values will not change.\n- Changed Invoice response\n  - description: `name_on_account`, `first_name`, `last_name`, `company` will be returned within `address`.\n- Changed `PUT /v2/subscriptions/:uuid/notes`\n  - Added `<custom_fields type=\"array\">` so that the programmer can update custom fields without\n    clearing pending subscription changes or reactivating the subscription.\n[block:api-header]\n{\n  \"title\": \"v2.13 Release Notes\"\n}\n[/block]\nRequest and Response changes:\n\n- Changed Plan POST request/response\n  - Added `<auto_renew>` Boolean default: true\n- Changed Plan PUT request/response\n  - Added `<auto_renew>` Boolean default: true\n- Changed Subscription POST request/response\n  - Added `<auto_renew>` Boolean default: true\n  - Added `<renewal_billing_cycles>` Integer default: nil\n- Changed Subscription response\n  - Added `<current_term_started_at>` Datetime default: nil\n  - Added `<current_term_ends_at>` Datetime default: nil\n- Changed Shipping Address request/response XML:\n  - Accept new attributes `first_name` and `last_name` for shipping addresses\n  - Return new attributes `first_name` and `last_name` in address xml for addresses created using new attributes\n- Changed Purchases POST response\n  - Return new attributes `name`,  `first_name` and `last_name` in line item address xml\n- Changed Account, Subscription, and Purchase request/response\n  - Added optional `<custom_fields>` list to account and subscription xml entities\n    - path: `<account><custom_fields><custom_field><name></name><value></value></custom_field></custom_fields></account>`\n    - path: `<subscription><custom_fields><custom_field><name></name><value></value></custom_field></custom_fields></subscription>`\n    - path: `<subscription><account><custom_fields><custom_field><name></name><value></value></custom_field></custom_fields></subscription>`\n    - path: `<purchase><subscriptions><subscription><custom_fields><custom_field><name></name><value></value></custom_field></custom_fields></subscription></subscriptions></purchase>`\n    - path: `<purchase><account><custom_fields><custom_field><name></name><value></value></custom_field></custom_fields></account></purchase>`\n    - description: Allows fetch, create, update, and delete of Custom Fields on Accounts and Subscriptions.\n      Custom Field must be configured through the Admin UI before accessing them through the API.\n      To create or update a custom field, add the name & new value to the `<custom_fields></custom_fields>` list. The field will be created if it does not exist yet.\n      To delete a custom field, add the name & an empty value to the list:\n        `<custom_field><name>[name_of_existing_field]</name><value></value></custom_field>`\n      Existing values which are not present in the request will not be modified.\n- Change Subscription PUT request/response\n  - Added `<auto_renew>` and `<renewal_billing_cycles>`\n- Change Plans PUT request/response\n  - Modifying `<plan_interval_unit>` will result in an error: `Plan interval unit cannot be edited once a plan is created.`\n  - Modifying `<plan_interval_length>` will result in an error: `Plan interval length cannot be edited once a plan is created.`\n[block:api-header]\n{\n  \"title\": \"v2.12 Release Notes\"\n}\n[/block]\nRoute changes:\n\n- Added `GET /v2/invoices/:invoice_number/transactions`\n\nRequest and Response changes:\n\n- Changed Account response\n  - Added `<all_transactions>` href to list an invoices transactions if there are > 500 transactions on the invoice\n- Changed Gift Card response\n  - Added `<redemption_invoice>`\n    - description: When a gift card is redemeed with the Credit Memos enabled, a credit invoice is created. A link to that credit invoice is returned in `<redemption_invoice>`\n  - Renamed `<invoice>` to `<purchase_invoice>`\n\n[block:api-header]\n{\n  \"title\": \"v2.11 Release Notes\"\n}\n[/block]\nRequest and Response changes:\n\n- Changed Account POST request/response\n  - Added `<preferred_locale>`\n- Changed Account PUT request/response\n  - Added `<preferred_locale>`\n- Changes `POST /v2/purchases/` and `POST /v2/purchases/preview` requests\n  - Added `<shipping_address_id>`\n    - path: `<purchase><shipping_address_id></shipping_address_id></purchase>`\n    - description: Adds support for referencing an existing account shipping addresses id for the purchase. This will\n      apply to all subscriptions in the purchase unless those subscriptions have their own shipping addresses\n      designated.\n  - Added `<shipping_address>`\n    - path: `<account><shipping_address></shipping_address></account>`\n    - description: Adds support for creating new account shipping addresses. The last shipping_address tag will\n      get applied to all the subscriptions and/or adjustments on the purchase unless those subscriptions and/or\n      adjustments have their own shipping addresses designated.\n  - Added `<shipping_address_id>`\n    - path: `<subscriptions><subscription><shipping_address_id></shipping_address_id></subscription></subscriptions>`\n    - description: Adds support for referencing an existing account shipping addresses id on the subscription\n  - Added `<shipping_address>`\n    - path: `<subscriptions><subscription><shipping_address></shipping_address></subscription></subscriptions>`\n    - description: Adds support for creating new subscription shipping addresses\n  - Added `<shipping_address_id>`\n    - path: `<adjustments><adjustment><shipping_address_id></shipping_address_id></subscription></adjustments>`\n    - description: Adds support for referencing an existing account shipping addresses id on an adjustment\n  - Added `<shipping_address>`\n    - path: `<adjustments><adjustment><shipping_address></shipping_address></subscription></adjustments>`\n    - description: Adds support for creating new adjustment shipping addresses\n- Changed `GET /v2/adjustments/:adjustment_id`\n  - Added `<shipping_address></shipping_address>`\n    - path: `<adjustment><shipping_address></shipping_address></adjustment>`\n    - description: Adds shipping address info for an adjustment\n- Changed `GET /v2/invoices`\n  - Added `<shipping_address>`\n    - path: `<line_items><adjustment><shipping_address></shipping_address></adjustment></line_items>`\n    - description: Adds shipping address info for adjustments under invoices\n- Changed `GET /v2/invoices/:invoice_number`\n  - Added `<shipping_address>`\n    - path: `<line_items><adjustment><shipping_address></shipping_address></adjustment></line_items>`\n    - description: Adds shipping address info for adjustments under an invoice\n- Added `PUT /v2/subscriptions/:uuid/pause`\n  - description: Sets a subscription's `paused_at` and `remaining_pause_cycles` attributes to facilitate the scheduling of a pause starting at the next billing cycle\n- Added `PUT /v2/subscriptions/:uuid/resume`\n  - description: Immediately resumes a paused subscription, applying any pending changes and producing an invoice\n- Changed Subscription response\n  - Added `<state>` value:\n    - `paused`\n- Changed Account request/response\n  - Added `<has_paused_subscription>` element\n[block:api-header]\n{\n  \"title\": \"v2.10 Release Notes\"\n}\n[/block]\nRoute changes:\n\n- Added `GET /v2/credit_payments`\n- Added `GET /v2/credit_payments/:uuid`\n- Added `GET /v2/adjustments/:adjustment_id/credit_adjustments`\n- Added `GET /v2/accounts/:account_code/credit_payments`\n- Added `GET /v2/invoices/:invoice_number/original_invoices`\n- Added `GET /v2/invoices/:invoice_number/credit_invoices`\n- Added `PUT /v2/invoices/:invoice_number/void`\n  - description: Reduces a credit invoice's balance to zero. The credit invoice's state\n    is set to voided (if it has a full balance) or closed (if it has a partial balance)\n- Added `POST /v2/accounts/:account_code/billing_info/verify_cvv`\n  - description: Verify a given CVV against an account's billing info\n\nRequest and Response Changes:\n\n- Changed `POST /v2/invoices/:invoice_number/refund` request\n  - Added `<credit_customer_notes>` element if site has Credit Memos\n    - description: Adds notes to refund credit invoice\n  - Added `<external_refund>` element if site has Credit Memos\n    - description: Allowed values are true or false and designates that the refund transactions created are manual\n  - Added `<payment_method>` element if site has Credit Memos\n    - description: Allowed if `<external_refund>` is true and creates the manual transactions with this payment method\n  - Added `<description>` element if site has Credit Memos\n    - description: Allowed if `<external_refund>` is true and sets this value as the transaction_note on the manual\n      transactions created\n  - Added `<refunded_at>` element if site has Credit Memos\n    - description: Allowed if `<external_refund>` is true and sets this value as the collected_at on the manual\n      transactions created\n  - Replaced `<refund_apply_order>` with `<refund_method>`\n    - description: Allowed values are credit_first or transaction_first without Credit Memos and additional\n      accepted values of all_credit and all_transaction with Credit Memos\n- Changes `POST /v2/purchases/` request\n  - Added `<invoice_collection>` element if site has Credit Memos\n    - description: A list of invoices created by the invoicing service: charge_invoice and credit_invoices array\n  - Added `<credit_customer_notes>` element if site has Credit Memos\n    - description: Adds notes to custom credit invoice if generated\n- Changed Subscription creation and preview POST request\n  - Added `<credit_customer_notes>` element if site has Credit Memos\n- Changed Subscription preview and preview_update POST request\n  - Added `<invoice_collection>` element if site has Credit Memos\n    - description: A list of invoices created by the invoicing service: charge_invoice and credit_invoices array\n- Changed Invoice creation and preview POST request\n  - Added `<credit_customer_notes>` element if site has Credit Memos\n  - Added `<type>` element if site has Credit Memos\n  - Added `<origin>` element if site has Credit Memos\n  - Renamed `<subtotal_in_cents>` to `<subtotal_before_discount_in_cents>`\n  - Renamed `<subtotal_after_discount_in_cents>` to `<subtotal_in_cents>`\n  - Added `<discount_in_cents>`\n  - Added `<balance_in_cents>` if site has Credit Memos\n  - Added `<due_on>` element if site has Credit Memos\n  - Added `<type>` element if site has Credit Memos\n  - Added `<origin>` element if site has Credit Memos\n  - Added `<credit_invoices>` reference link when site has Credit Memos and the invoice is a Charge Invoice\n  - Added `<original_invoices>` reference link when site has Credit Memos and the invoice is a Credit Invoice\n  - Added `<invoice_collection>` element if site has Credit Memos\n    - description: A list of invoices created by the invoicing service: charge_invoice and credit_invoices array\n- Changed `GET /v2/invoices/:invoice_number`\n  - Added void action for voidable credit invoices, `<a name=\"void\" href=\"<domain>/v2/invoices/:invoice_number/void\" method=\"put\"/>`\n  - Added `credit_payments`\n    - path: `<credit_payments type=\"array\"><credit_payment /></credit_payments>`\n    - description: A list of credit payments applied to the invoice\n  - Changed `<state>` values\n    - `collected` has changed to `paid`\n    - `open` has changed to `pending`\n- Changed Adjustments POST request/response\n  - Added `<credit_reason_code>`\n- Changed Adjustments GET response\n  - Added reference to new `credit_adjustments` endpoint for adjustments of type `charge`\n- Changed `GET /v2/transactions`\n  - Added `<reference>`\n    - path: <transactions><transaction><fraud_info><reference></reference></fraud_info></transaction></transactions>\n    - description: Adds Kount reference ID for fraud details under transactions\n- Changed `GET /v2/transactions/:transaction_uuid`\n  - Added `<reference>`\n    - path: <transaction><fraud_info><reference></reference></fraud_info></transaction>\n    - description: Adds Kount reference ID for fraud details under a transaction\n[block:api-header]\n{\n  \"title\": \"v2.9 Release Notes\"\n}\n[/block]\nRoute changes:\n\n- Added `POST /v2/purchases/authorize`\n\nRequest and Response Changes:\n\n- Changed `GET /v2/adjustments/:adjustment_id`\n  - Changed `<subscription>`\n    - path: `<subscription href=\"\"></subscription>`\n    - description: tag is only returned if adjustment is originating from a subscription plan\n      charge, setup fee, add on, trial or proration credit.  It is no longer\n      returned for other adjustments\n  - Added `<proration_rate>`\n    - path: `<proration_rate type=\"float\">0.500</proration_rate>`\n    - description: The proration rate is only present on prorated adjustments. It represents how much the adjustment\n      was prorated to account for a mid cycle subscription change.\n- Changed `<invoice>` and `<transaction>` responses\n  - Removed deprecated singular `<subscription>` links. Now only plural `<subscriptions>`\n    links are returned.\n- Changed `GET /v2/subscriptions` and `GET /v2/account/:account_code/subscriptions`\n  to accept a `started_with_gift` parameter. It can generate some slower queries\n  so we're going to leave it out of the public docs.\n[block:api-header]\n{\n  \"title\": \"v2.8 Release Notes\"\n}\n[/block]\nRoute changes:\n\n- Added `GET /v2/invoices/:invoice_number/subscriptions`\n- Added `GET /v2/transactions/:transaction_id/subscriptions`\n\nRequest and Response Changes:\n\n- Changed `POST /v2/accounts` request:\n  - Validates `address.country`, `billing_info.country`, and `shipping_address.country`\n    for 2 letter ISO 3166 country code.\n- Changed `PUT /v2/accounts/:account_code` request:\n  - Validates `address.country`, `billing_info.country`, and `shipping_address.country`\n    for 2 letter ISO 3166 country code.\n- Changed `POST /v2/subscriptions` request:\n  - Validates `account.address.country`, `account.billing_info.country`,\n    `account.shipping_addresses.shipping_address.country`, and `shipping_address.country`\n    for 2 letter ISO 3166 country code.\n- Changed `PUT /v2/subscriptions/:subscription_uuid` request:\n  - Validates `shipping_address.country` for 2 letter ISO 3166 country code.\n- Changed `PUT /v2/accounts/:account_code/billing_info` request:\n  - Validates `country` for 2 letter ISO 3166 country code.\n- Changed `POST /v2/accounts/:account_code/shipping_addresses/` request:\n  - Validates `country` for 2 letter ISO 3166 country code.\n- Changed `PUT /v2/accounts/:account_code/shipping_addresses/:shipping_address_id` request:\n  - Validates `country` for 2 letter ISO 3166 country code.\n- Changed `POST /v2/gift_cards` request:\n  - Validates `gifter_account.address.country`, `gifter_account.billing_info.address.country`,\n    `gifter_account.shipping_addresses.country` for 2 letter ISO 3166 country code.\n- Added support for multiple subscriptions in `POST /v2/purchases`\n- Added custom note support for `POST /v2/purchases`\n  - Added `<terms_and_conditions>` element\n  - Added `<customer_notes>` element\n  - Added `<vat_reverse_charge_notes>` element\n- Changed `POST /v2/purchases` request:\n  - `<currency>` tag no longer allowed under `<adjustment>`. `<currency>` is an invoice level tag and is not\n    permitted under an adjustment.\n- Changed `POST /v2/subscriptions` and `PUT /v2/subscriptions/:uuid` request / `GET /v2/subscriptions/:uuid` response:\n  - Added boolean `<imported_trial>` element\n    - path: `<subscription><imported_trial>true|false</imported_trial></subscription>`\n    - description: A boolean value that indicates if the subscription is to be treated as an import for data\n      analysis or a real trial. This value can only be changed on a trial subscription and is persisted for its\n      lifetime.\n- Changed `GET /v2/invoices/:invoice_number`\n  - Added `<subscriptions>`\n    - path: `<subscriptions href=\"\"</subscriptions>`\n    - description: new `subscriptions` tag contains a link to new\n      endpoint for subscriptions on an invoice\n      (`GET /v2/invoices/:invoice_number/subscriptions`)\n- Changed `GET /v2/transactions/:transaction_id`\n  - Added `<subscriptions>`\n    - path: `<subscriptions href=\"\"</subscriptions>`\n    - description: new `subscriptions` tag contains a link to new\n      endpoint for subscriptions associated with a transaction\n      (`GET /v2/transactions/:transaction_id/subscriptions`)\n[block:api-header]\n{\n  \"title\": \"v2.7 Release Notes\"\n}\n[/block]\n\nRequest and Response Changes:\n\n- Changed `POST /v2/purchases` request:\n  - Added `coupon_codes`\n    - path: `<coupon_codes type=\"array\"><coupon_code>COUPON1234</coupon_code></coupon_codes>`\n    - description: A list of coupon codes to apply to this purchase.\n  - Added `subscriptions`\n    - path: `<subscriptions type=\"array\"><subscription/></subscriptions>`\n    - description: A list of Subscriptions to invoice in this purchase (currently only one subscription is allowed).\n  - Added `gift_card`\n    - path: `<gift_card><redemption_code>ABCD1234</redemption_code></gift_card>`\n    - description: A gift card with a redemption code to apply to this purchase.\n[block:api-header]\n{\n  \"title\": \"v2.6 Release Notes\"\n}\n[/block]\nRoute changes:\n\nRequest and Response Changes:\n\n- Changed Plan request/response:\n  - Added `<trial_requires_billing_info>` element.\n- Changed Subscription response:\n  - Added `<no_billing_info_reason>` element.\n- Added `POST /v2/purchases`\n- Added `POST /v2/purchases/preview`\n- Changed Subscription behavior\n  - For `POST /v2/subscriptions`\n    Sending NULL for `total_billing_cycles` attribute\n    will now override plan `total_billing_cycles` setting\n    and will make subscription renew forever.  Omitting\n    the attribute will cause the setting to default to\n    the value of plan `total_billing_cycles`\n\n[block:api-header]\n{\n  \"title\": \"v2.5 Release Notes\"\n}\n[/block]\nRoute changes:\n\n- Added `PUT /v2/invoices/:invoice_number/collect`\n\nRequest and Response Changes:\n\n- Changed Subscription response:\n  - Added `<started_with_gift>` element.\n  - Added `<converted_at>` element.\n- Changed Billing Info response:\n  - Added `<updated_at>` element.\n- Changed Coupon response:\n  - Added `<id>` element.\n- Changed Invoice response:\n  - Added `<subtotal_after_discount_in_cents>` element.\n  - Added `<attempt_next_collection_at>` element.\n  - Added `<recovery_reason>` element.\n  - Added `<all_line_items>` link when invoice response only shows first 500 line items.\n- Changed Transaction response:\n  - Added `<gateway_type>` element.\n  - Added `<origin>` element.\n  - Added `<description>` element.\n  - Added `<message>` element.\n  - Added `<approval_code>` element.\n  - Added `<collected_at>` element.\n- Changed Account response:\n  - Added `<has_live_subscription>` element.\n  - Added `<has_active_subscription>` element.\n  - Added `<has_future_subscription>` element.\n  - Added `<has_canceled_subscription>` element.\n  - Added `<has_past_due_invoice>` element.\n- Added `GET /v2/invoices/:invoice_number/adjustments`\n- Changed Adjustment POST request:\n  - Added `<product_code>` element.\n- Changed Transactions POST request:\n  - Added `<product_code>` element.\n- Changed Invoice Preview POST request:\n  - Added optional `<currency>` element. This change affects all versions of the API.\n- Changed Invoice POST request:\n  - Added optional `<currency>` element. This change affects all versions of the API.\n\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] { "title": "v2.17 Release Notes" } [/block] - Changed Account request/response: - 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. - Changed `PUT /v2/subscriptions/:uuid/notes`: - Added `<gateway_code>` tag to subscription xml. Allows subscription's `gateway_code` to be immediately updated. - Changed `PUT /v2/invoices/:uuid`: - Added `<gateway_code>` tag to invoice xml. Allows invoice's `gateway_code` to be immediately updated. - Changed `POST v2/purchases` request: - Allow `starts_at` to specify a future date when a subscription should start. Previous versions only allowed subscriptions to start immediately via this endpoint. [block:api-header] { "title": "v2.16 Release Notes" } [/block] Request and Response changes: - Changed `POST v2/purchases` request: - Allow `po_number` when collection method is `automatic` and manual invoicing is enabled. - Changed `PUT /v2/accounts/:account_code/billing_info` request: - Added support for updating billing info with a gateway code and token. Previous versions only allowed creating a new billing info, not updating existing billing info. - Changed `PUT /v2/accounts/:account_code/billing_info` response: - Added <gateway_code> and (masked) <gateway_token> to response when updating a billing info with gateway code and token, so it maps to the request that was sent. [block:api-header] { "title": "v2.15 Release Notes" } [/block] Request and Response changes: - Changed `Account` response: - Added <notes> href tag so client libraries have the link for listing account notes. - Changed `POST v2/accounts/:account_code/billing_info` request - Added <card_type> String - Changed `POST v2/subscriptions` request when including billing info - Added <card_type> String [block:api-header] { "title": "v2.14 Release Notes" } [/block] Request and Response changes: - Changed Subscription create request format: - Added `<next_bill_date>` Datetime. - description: `<first_renewal_date>` is now deprecated. Use `<next_bill_date>` instead. - Added `PUT /v2/invoices/:invoice_number` - description: If the `Edit Invoice` feature flag is enabled, several fields on invoices are editable. This includes `customer_notes`, and `terms_and_conditions`. `vat_reverse_charge_notes` can be edited only if the invoice already had reverse charge notes. `po_number` is editable except for credit invoices. `name_on_account`, `first_name`, `last_name`, `company`, and `phone` are editable on `address`. `address1`, `address2`, `city`, `state`, `zip` and `country` on `address` are also editable, if the invoice doesn't have tax applied, and site doesn't have taxes enabled. `net_terms` is editable, only for manual invoices in pending or past due states. Only the invoice and address fields (as listed above) in the request will be updated; fields not present in the request will not be updated, and their values will not change. - Changed Invoice response - description: `name_on_account`, `first_name`, `last_name`, `company` will be returned within `address`. - Changed `PUT /v2/subscriptions/:uuid/notes` - Added `<custom_fields type="array">` so that the programmer can update custom fields without clearing pending subscription changes or reactivating the subscription. [block:api-header] { "title": "v2.13 Release Notes" } [/block] Request and Response changes: - Changed Plan POST request/response - Added `<auto_renew>` Boolean default: true - Changed Plan PUT request/response - Added `<auto_renew>` Boolean default: true - Changed Subscription POST request/response - Added `<auto_renew>` Boolean default: true - Added `<renewal_billing_cycles>` Integer default: nil - Changed Subscription response - Added `<current_term_started_at>` Datetime default: nil - Added `<current_term_ends_at>` Datetime default: nil - Changed Shipping Address request/response XML: - Accept new attributes `first_name` and `last_name` for shipping addresses - Return new attributes `first_name` and `last_name` in address xml for addresses created using new attributes - Changed Purchases POST response - Return new attributes `name`, `first_name` and `last_name` in line item address xml - Changed Account, Subscription, and Purchase request/response - Added optional `<custom_fields>` list to account and subscription xml entities - path: `<account><custom_fields><custom_field><name></name><value></value></custom_field></custom_fields></account>` - path: `<subscription><custom_fields><custom_field><name></name><value></value></custom_field></custom_fields></subscription>` - path: `<subscription><account><custom_fields><custom_field><name></name><value></value></custom_field></custom_fields></subscription>` - path: `<purchase><subscriptions><subscription><custom_fields><custom_field><name></name><value></value></custom_field></custom_fields></subscription></subscriptions></purchase>` - path: `<purchase><account><custom_fields><custom_field><name></name><value></value></custom_field></custom_fields></account></purchase>` - description: Allows fetch, create, update, and delete of Custom Fields on Accounts and Subscriptions. Custom Field must be configured through the Admin UI before accessing them through the API. To create or update a custom field, add the name & new value to the `<custom_fields></custom_fields>` list. The field will be created if it does not exist yet. To delete a custom field, add the name & an empty value to the list: `<custom_field><name>[name_of_existing_field]</name><value></value></custom_field>` Existing values which are not present in the request will not be modified. - Change Subscription PUT request/response - Added `<auto_renew>` and `<renewal_billing_cycles>` - Change Plans PUT request/response - Modifying `<plan_interval_unit>` will result in an error: `Plan interval unit cannot be edited once a plan is created.` - Modifying `<plan_interval_length>` will result in an error: `Plan interval length cannot be edited once a plan is created.` [block:api-header] { "title": "v2.12 Release Notes" } [/block] Route changes: - Added `GET /v2/invoices/:invoice_number/transactions` Request and Response changes: - Changed Account response - Added `<all_transactions>` href to list an invoices transactions if there are > 500 transactions on the invoice - Changed Gift Card response - Added `<redemption_invoice>` - description: When a gift card is redemeed with the Credit Memos enabled, a credit invoice is created. A link to that credit invoice is returned in `<redemption_invoice>` - Renamed `<invoice>` to `<purchase_invoice>` [block:api-header] { "title": "v2.11 Release Notes" } [/block] Request and Response changes: - Changed Account POST request/response - Added `<preferred_locale>` - Changed Account PUT request/response - Added `<preferred_locale>` - Changes `POST /v2/purchases/` and `POST /v2/purchases/preview` requests - Added `<shipping_address_id>` - path: `<purchase><shipping_address_id></shipping_address_id></purchase>` - description: Adds support for referencing an existing account shipping addresses id for the purchase. This will apply to all subscriptions in the purchase unless those subscriptions have their own shipping addresses designated. - Added `<shipping_address>` - path: `<account><shipping_address></shipping_address></account>` - description: Adds support for creating new account shipping addresses. The last shipping_address tag will get applied to all the subscriptions and/or adjustments on the purchase unless those subscriptions and/or adjustments have their own shipping addresses designated. - Added `<shipping_address_id>` - path: `<subscriptions><subscription><shipping_address_id></shipping_address_id></subscription></subscriptions>` - description: Adds support for referencing an existing account shipping addresses id on the subscription - Added `<shipping_address>` - path: `<subscriptions><subscription><shipping_address></shipping_address></subscription></subscriptions>` - description: Adds support for creating new subscription shipping addresses - Added `<shipping_address_id>` - path: `<adjustments><adjustment><shipping_address_id></shipping_address_id></subscription></adjustments>` - description: Adds support for referencing an existing account shipping addresses id on an adjustment - Added `<shipping_address>` - path: `<adjustments><adjustment><shipping_address></shipping_address></subscription></adjustments>` - description: Adds support for creating new adjustment shipping addresses - Changed `GET /v2/adjustments/:adjustment_id` - Added `<shipping_address></shipping_address>` - path: `<adjustment><shipping_address></shipping_address></adjustment>` - description: Adds shipping address info for an adjustment - Changed `GET /v2/invoices` - Added `<shipping_address>` - path: `<line_items><adjustment><shipping_address></shipping_address></adjustment></line_items>` - description: Adds shipping address info for adjustments under invoices - Changed `GET /v2/invoices/:invoice_number` - Added `<shipping_address>` - path: `<line_items><adjustment><shipping_address></shipping_address></adjustment></line_items>` - description: Adds shipping address info for adjustments under an invoice - Added `PUT /v2/subscriptions/:uuid/pause` - description: Sets a subscription's `paused_at` and `remaining_pause_cycles` attributes to facilitate the scheduling of a pause starting at the next billing cycle - Added `PUT /v2/subscriptions/:uuid/resume` - description: Immediately resumes a paused subscription, applying any pending changes and producing an invoice - Changed Subscription response - Added `<state>` value: - `paused` - Changed Account request/response - Added `<has_paused_subscription>` element [block:api-header] { "title": "v2.10 Release Notes" } [/block] Route changes: - Added `GET /v2/credit_payments` - Added `GET /v2/credit_payments/:uuid` - Added `GET /v2/adjustments/:adjustment_id/credit_adjustments` - Added `GET /v2/accounts/:account_code/credit_payments` - Added `GET /v2/invoices/:invoice_number/original_invoices` - Added `GET /v2/invoices/:invoice_number/credit_invoices` - Added `PUT /v2/invoices/:invoice_number/void` - description: Reduces a credit invoice's balance to zero. The credit invoice's state is set to voided (if it has a full balance) or closed (if it has a partial balance) - Added `POST /v2/accounts/:account_code/billing_info/verify_cvv` - description: Verify a given CVV against an account's billing info Request and Response Changes: - Changed `POST /v2/invoices/:invoice_number/refund` request - Added `<credit_customer_notes>` element if site has Credit Memos - description: Adds notes to refund credit invoice - Added `<external_refund>` element if site has Credit Memos - description: Allowed values are true or false and designates that the refund transactions created are manual - Added `<payment_method>` element if site has Credit Memos - description: Allowed if `<external_refund>` is true and creates the manual transactions with this payment method - Added `<description>` element if site has Credit Memos - description: Allowed if `<external_refund>` is true and sets this value as the transaction_note on the manual transactions created - Added `<refunded_at>` element if site has Credit Memos - description: Allowed if `<external_refund>` is true and sets this value as the collected_at on the manual transactions created - Replaced `<refund_apply_order>` with `<refund_method>` - description: Allowed values are credit_first or transaction_first without Credit Memos and additional accepted values of all_credit and all_transaction with Credit Memos - Changes `POST /v2/purchases/` request - Added `<invoice_collection>` element if site has Credit Memos - description: A list of invoices created by the invoicing service: charge_invoice and credit_invoices array - Added `<credit_customer_notes>` element if site has Credit Memos - description: Adds notes to custom credit invoice if generated - Changed Subscription creation and preview POST request - Added `<credit_customer_notes>` element if site has Credit Memos - Changed Subscription preview and preview_update POST request - Added `<invoice_collection>` element if site has Credit Memos - description: A list of invoices created by the invoicing service: charge_invoice and credit_invoices array - Changed Invoice creation and preview POST request - Added `<credit_customer_notes>` element if site has Credit Memos - Added `<type>` element if site has Credit Memos - Added `<origin>` element if site has Credit Memos - Renamed `<subtotal_in_cents>` to `<subtotal_before_discount_in_cents>` - Renamed `<subtotal_after_discount_in_cents>` to `<subtotal_in_cents>` - Added `<discount_in_cents>` - Added `<balance_in_cents>` if site has Credit Memos - Added `<due_on>` element if site has Credit Memos - Added `<type>` element if site has Credit Memos - Added `<origin>` element if site has Credit Memos - Added `<credit_invoices>` reference link when site has Credit Memos and the invoice is a Charge Invoice - Added `<original_invoices>` reference link when site has Credit Memos and the invoice is a Credit Invoice - Added `<invoice_collection>` element if site has Credit Memos - description: A list of invoices created by the invoicing service: charge_invoice and credit_invoices array - Changed `GET /v2/invoices/:invoice_number` - Added void action for voidable credit invoices, `<a name="void" href="<domain>/v2/invoices/:invoice_number/void" method="put"/>` - Added `credit_payments` - path: `<credit_payments type="array"><credit_payment /></credit_payments>` - description: A list of credit payments applied to the invoice - Changed `<state>` values - `collected` has changed to `paid` - `open` has changed to `pending` - Changed Adjustments POST request/response - Added `<credit_reason_code>` - Changed Adjustments GET response - Added reference to new `credit_adjustments` endpoint for adjustments of type `charge` - Changed `GET /v2/transactions` - Added `<reference>` - path: <transactions><transaction><fraud_info><reference></reference></fraud_info></transaction></transactions> - description: Adds Kount reference ID for fraud details under transactions - Changed `GET /v2/transactions/:transaction_uuid` - Added `<reference>` - path: <transaction><fraud_info><reference></reference></fraud_info></transaction> - description: Adds Kount reference ID for fraud details under a transaction [block:api-header] { "title": "v2.9 Release Notes" } [/block] Route changes: - Added `POST /v2/purchases/authorize` Request and Response Changes: - Changed `GET /v2/adjustments/:adjustment_id` - Changed `<subscription>` - path: `<subscription href=""></subscription>` - description: tag is only returned if adjustment is originating from a subscription plan charge, setup fee, add on, trial or proration credit. It is no longer returned for other adjustments - Added `<proration_rate>` - path: `<proration_rate type="float">0.500</proration_rate>` - description: The proration rate is only present on prorated adjustments. It represents how much the adjustment was prorated to account for a mid cycle subscription change. - Changed `<invoice>` and `<transaction>` responses - Removed deprecated singular `<subscription>` links. Now only plural `<subscriptions>` links are returned. - Changed `GET /v2/subscriptions` and `GET /v2/account/:account_code/subscriptions` to accept a `started_with_gift` parameter. It can generate some slower queries so we're going to leave it out of the public docs. [block:api-header] { "title": "v2.8 Release Notes" } [/block] Route changes: - Added `GET /v2/invoices/:invoice_number/subscriptions` - Added `GET /v2/transactions/:transaction_id/subscriptions` Request and Response Changes: - Changed `POST /v2/accounts` request: - Validates `address.country`, `billing_info.country`, and `shipping_address.country` for 2 letter ISO 3166 country code. - Changed `PUT /v2/accounts/:account_code` request: - Validates `address.country`, `billing_info.country`, and `shipping_address.country` for 2 letter ISO 3166 country code. - Changed `POST /v2/subscriptions` request: - Validates `account.address.country`, `account.billing_info.country`, `account.shipping_addresses.shipping_address.country`, and `shipping_address.country` for 2 letter ISO 3166 country code. - Changed `PUT /v2/subscriptions/:subscription_uuid` request: - Validates `shipping_address.country` for 2 letter ISO 3166 country code. - Changed `PUT /v2/accounts/:account_code/billing_info` request: - Validates `country` for 2 letter ISO 3166 country code. - Changed `POST /v2/accounts/:account_code/shipping_addresses/` request: - Validates `country` for 2 letter ISO 3166 country code. - Changed `PUT /v2/accounts/:account_code/shipping_addresses/:shipping_address_id` request: - Validates `country` for 2 letter ISO 3166 country code. - Changed `POST /v2/gift_cards` request: - Validates `gifter_account.address.country`, `gifter_account.billing_info.address.country`, `gifter_account.shipping_addresses.country` for 2 letter ISO 3166 country code. - Added support for multiple subscriptions in `POST /v2/purchases` - Added custom note support for `POST /v2/purchases` - Added `<terms_and_conditions>` element - Added `<customer_notes>` element - Added `<vat_reverse_charge_notes>` element - Changed `POST /v2/purchases` request: - `<currency>` tag no longer allowed under `<adjustment>`. `<currency>` is an invoice level tag and is not permitted under an adjustment. - Changed `POST /v2/subscriptions` and `PUT /v2/subscriptions/:uuid` request / `GET /v2/subscriptions/:uuid` response: - Added boolean `<imported_trial>` element - path: `<subscription><imported_trial>true|false</imported_trial></subscription>` - description: A boolean value that indicates if the subscription is to be treated as an import for data analysis or a real trial. This value can only be changed on a trial subscription and is persisted for its lifetime. - Changed `GET /v2/invoices/:invoice_number` - Added `<subscriptions>` - path: `<subscriptions href=""</subscriptions>` - description: new `subscriptions` tag contains a link to new endpoint for subscriptions on an invoice (`GET /v2/invoices/:invoice_number/subscriptions`) - Changed `GET /v2/transactions/:transaction_id` - Added `<subscriptions>` - path: `<subscriptions href=""</subscriptions>` - description: new `subscriptions` tag contains a link to new endpoint for subscriptions associated with a transaction (`GET /v2/transactions/:transaction_id/subscriptions`) [block:api-header] { "title": "v2.7 Release Notes" } [/block] Request and Response Changes: - Changed `POST /v2/purchases` request: - Added `coupon_codes` - path: `<coupon_codes type="array"><coupon_code>COUPON1234</coupon_code></coupon_codes>` - description: A list of coupon codes to apply to this purchase. - Added `subscriptions` - path: `<subscriptions type="array"><subscription/></subscriptions>` - description: A list of Subscriptions to invoice in this purchase (currently only one subscription is allowed). - Added `gift_card` - path: `<gift_card><redemption_code>ABCD1234</redemption_code></gift_card>` - description: A gift card with a redemption code to apply to this purchase. [block:api-header] { "title": "v2.6 Release Notes" } [/block] Route changes: Request and Response Changes: - Changed Plan request/response: - Added `<trial_requires_billing_info>` element. - Changed Subscription response: - Added `<no_billing_info_reason>` element. - Added `POST /v2/purchases` - Added `POST /v2/purchases/preview` - Changed Subscription behavior - For `POST /v2/subscriptions` Sending NULL for `total_billing_cycles` attribute will now override plan `total_billing_cycles` setting and will make subscription renew forever. Omitting the attribute will cause the setting to default to the value of plan `total_billing_cycles` [block:api-header] { "title": "v2.5 Release Notes" } [/block] Route changes: - Added `PUT /v2/invoices/:invoice_number/collect` Request and Response Changes: - Changed Subscription response: - Added `<started_with_gift>` element. - Added `<converted_at>` element. - Changed Billing Info response: - Added `<updated_at>` element. - Changed Coupon response: - Added `<id>` element. - Changed Invoice response: - Added `<subtotal_after_discount_in_cents>` element. - Added `<attempt_next_collection_at>` element. - Added `<recovery_reason>` element. - Added `<all_line_items>` link when invoice response only shows first 500 line items. - Changed Transaction response: - Added `<gateway_type>` element. - Added `<origin>` element. - Added `<description>` element. - Added `<message>` element. - Added `<approval_code>` element. - Added `<collected_at>` element. - Changed Account response: - Added `<has_live_subscription>` element. - Added `<has_active_subscription>` element. - Added `<has_future_subscription>` element. - Added `<has_canceled_subscription>` element. - Added `<has_past_due_invoice>` element. - Added `GET /v2/invoices/:invoice_number/adjustments` - Changed Adjustment POST request: - Added `<product_code>` element. - Changed Transactions POST request: - Added `<product_code>` element. - Changed Invoice Preview POST request: - Added optional `<currency>` element. This change affects all versions of the API. - Changed Invoice POST request: - Added optional `<currency>` element. This change affects all versions of the API. [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.