Vertex tax integration

Unlock global tax calculation on your Recurly invoices with Vertex O Series or Vertex Cloud integration. Seamlessly calculate and apply accurate taxes to enhance compliance and efficiency.



Required plan

This feature is only available to customers on the Elite subscription plan. To request to upgrade to this plan, please reach out to your Recurly account manager or [email protected] for more details.

Additional cost

This feature or setting requires an additional cost. Please reach out to your Recurly account manager or [email protected] for more pricing details.


  • Vertex account
  • Elite Recurly plan
  • Credit Invoices feature enabled


While Recurly extends support for a comprehensive set of Vertex tax parameters tailored to meet most common taxation scenarios, it is vital to understand that these parameters might not suffice for every unique taxation need. Given this, it is highly recommended that all merchants validate their specific taxation scenarios through a sandbox integration before implementing the Vertex integration in their live environment. This step ensures that the chosen Vertex configuration aligns perfectly with your distinct tax requirements, thereby promoting effective and compliant taxation practices in your business operations.


Recurly's Elite plan offers merchants the ability to perform global tax calculations on their invoices through integration with Vertex O Series or Vertex Cloud. Regardless of whether you prefer on-premise or on-demand solutions, Recurly supports both deployment modes for Vertex O Series and Vertex Cloud, including versions 7.0, 8.0, and 9.0.

Configure Recurly tax settings with Vertex

To ensure accurate tax calculations and compliance, Recurly provides several configuration options for integrating with Vertex. Here's a breakdown of the key features and how they can be used:

Your merchant address and tax registration numbers

In the Recurly Admin Console, under Configuration → Business Entities, you can configure your merchant address, which will be displayed on the invoices. This address is sent to Vertex as the merchant address and must meet certain requirements. You can also add tax registration numbers, such as VAT Number and Registration Number, which will appear on customer invoices under your address.

Customer address collection

When taxes are enabled, Recurly requires you to collect at least the customer's country. If you prefer not to ask customers for their country, you can infer it from other evidence and set it in the request to create the address in Recurly. It's important to collect enough address elements for Vertex to apply taxes correctly.

Configure plans and charges

To map your Recurly products to taxability rules in Vertex, you have two options: using Vertex Product or Vertex Product Class.

Using Vertex product

You can associate each Recurly product code (Plan Code, Add-On Code, Item Code, and adjustment Product Code) with a corresponding product rule in Vertex. This requires configuring each product code to match a specific product rule in Vertex. However, this option may not be ideal for large product catalogs as it requires consistent updates in both Recurly and Vertex.

Using Vertex product class

The recommended configuration is to use Vertex's Product Class. Create a Product Class in Vertex for each unique taxability rule and set that Product Class as the Tax Code for the corresponding products in Recurly. This approach provides more flexibility and requires maintaining up-to-date tax codes in Recurly when product classes are changed in Vertex.

Recurly tax codes

If you are not using Recurly Taxes powered by Avalara and have the Vertex feature on your site, you can set tax codes for plan fees, add-on fees, and one-time charges. The timing of setting tax codes depends on your circumstances:

  • No Existing Subscribers: If you're starting with a clean slate, ensure you set tax codes and add your Vertex credentials before processing invoices through Recurly.
  • Existing Subscribers, No Taxes Enabled: If you have existing subscribers being invoiced through Recurly without taxes, you can connect your Vertex credentials without enabling tax jurisdictions. When you're ready to start taxing, enable the jurisdictions in Vertex, and invoices will automatically return tax.
  • Existing Subscribers, Taxes Enabled: If you're transitioning from Recurly Taxes powered by Avalara to Vertex, Vertex will default to taxing your customers based on the physical tax rate. Enable the jurisdictions in Vertex that match your current tax setup in Recurly and add your Vertex credentials. Invoices will start flowing to your Vertex account immediately. After the transition, you can configure advanced taxability rules and add new jurisdictions using the tax code field.

If you're transitioning from your own Avalara account to Vertex, you need to configure your current tax codes as product classes in Vertex, mapping them to the appropriate taxability rules. Only after configuring your Avalara codes in Vertex should you add your Vertex credentials in Recurly. This ensures proper refund support for invoices processed through Avalara.

By configuring these settings, you can seamlessly integrate Recurly with Vertex for accurate tax calculations and compliance with tax regulations.


Once you enable Vertex, all customer invoices go to your Vertex account, regardless of their location. Invoices with tax included will show an additional Tax column in the line item table displaying the rate for each line item. Below the line item table, a tax section displays the total tax amount for the invoice. It appears below the Subtotal and above the Total, showing the location, tax type, and rate (e.g., “FR VAT 20%” for French VAT).

Tax previews

Recurly offers tax previews for Vertex customers via the API in the Preview Subscription, Preview Subscription Change, Preview Purchase, and Preview Invoice endpoints. These calls allow Recurly to query Vertex directly for tax information and return it in the preview. Currently, tax previews for Vertex are not supported by Recurly.js, the Recurly Admin Console, or the Hosted Payment Pages.
The previews are sent to Vertex as a Quotation Request and do not create entries in the Tax Journal.

Tax inclusive pricing

Tax inclusive pricing is available with Vertex. For more information, refer to the Tax Inclusive Pricing page.

Issued invoices

Recurly sends all issued invoices as an Invoice Request to Vertex, which creates an entry in the Tax Journal. Charge invoices send a positive Invoice Request, while credit invoices send a negative one. Events such as refunds, subscription changes, or write-offs lead to credit invoice events. Note that one-off credit invoices don't go to Vertex, as they're not related to a charge invoice and, therefore, don't include tax.

In certain scenarios, Recurly sends an additional request for the invoice to remove it from the Vertex Tax Journal:

  • Failed purchases due to credit card decline: Recurly sends a negative Invoice Request for the opposite amount to offset the initial invoice.
  • Voided credit invoice: Recurly sends a positive Invoice Request.

Exempt products or customers

If you wish to exempt certain line items from tax, you can do this at the plan, account, or one-time charge level. In the API, this is the tax_exempt attribute. If a plan or an account is exempt, all associated invoice line items are treated as exempt. However, if a one-time charge is exempt, only that specific line item is exempt. You can also configure a product or product class in Vertex to ensure the line item is tax-exempt.

Test your integration

Test your Vertex integration by adding credentials for a test Vertex instance to your Recurly sandbox site and configure as per the given instructions. Once ready to go live, add your production Vertex credentials to your production Recurly site. Be aware that as soon as you add Vertex credentials on your production Recurly site, all invoices start flowing to Vertex.

Disable Vertex

If you need to disable your Vertex integration, you can do this on the Taxes page by clicking “Disable Vertex”. This will clear all tax codes configured in your plans and halt tax collection on your invoices.


You can access invoice and line item tax rate, amount, type, and region data via exports and the API for your tax reporting needs.

Errors and downtime

Recurly, by default, blocks purchases when Vertex returns an error. You can disable this in the Recurly Admin Console under Configuration > Taxes > Tax Settings under “Tax Service Settings”.

Flexible fields

During integration setup, you can specify a FlexibleField ID and the value you'd like to pass into that FlexibleField for all Recurly documents (charge and credit invoices). This enables you to segment the data from a specific Recurly site from all other data you have in Vertex.

Field mapping

This section details the fields that Recurly sends to Vertex with each invoice that is created. This core set of data fields supports basic tax configurations. If you require additional fields as part of your tax setup, contact your Vertex rep and Recurly Sales or Support to see if that request can be supported.

Recurly AttributeVertex Attribute
Invoice numberRequest/documentNumber
Invoice posted dateRequest/documentDate
N/A Request/TransactionType (always sends "SALE")
Invoice currencyRequest/isoCurrencyCodeAlpha (defaults to "USD")
Vertex credentials/companyRequest/Seller/Company
Vertex credentials/divisionRequest/Seller/Division
Business Entity addressRequest/Seller/PhysicalOrigin
Customer account codeRequest/Customer/CustomerCode
Must be 40 characters or less.
Invoice taxable address (e.g. - Bill To or Ship To)Request/Customer/Destination
Request/LineItem/Customer/Destination (for credit line items)
VAT number for invoice taxable addressRequest/LineItem/Customer/TaxRegistration
Line item product code (e.g. - plan code, add-on code)Request/LineItem/Product
Line item tax codeRequest/LineItem/productClass
Line item subtotal after discountsRequest/LineItem/ExtendedPrice
Line item's original invoice number (for credit line items / refunds)Request/LineItem/FlexibleFields
Line items' original invoice posted date (for credit line items / refunds)Request/LineItem/taxDate


Vertex requires the Customer Code to be 40 characters or fewer. Recurly allows up to 50 characters for Account Code, so ensure that your Recurly Account Codes are within Vertex's character limit to avoid declined transactions.

Go live with Vertex checklist

To successfully integrate Vertex into your Recurly setup, follow this comprehensive checklist:

  1. Confirm your Business Entity company address is accurate.
  2. Determine which customer address (billing, account, or shipping) you wish to tax.
  3. Ensure your purchase form requires at least the minimum address fields needed for your tax regions.
  4. Confirm the current customer addresses you will tax are accurate and include a country.
  5. Configure your plans and charges with the correct taxability and tax codes.
  6. Enter your Vertex credentials on your production site before enabling the tax jurisdictions in Vertex.
  7. Update any purchase or subscription change previews to use Recurly's APIs for the tax preview portion, not Recurly.js.
  8. Mark any current customers as tax-exempt in their Account Info, if applicable.
  9. Test your integration on a sandbox site.
  10. Go live by activating your tax jurisdictions in Vertex.

Connect your Vertex account

To use the Vertex integration, please meet the following prerequisites:

  • You must be on the Elite Recurly plan.
  • The Credit Invoices feature should be enabled on your site (Configuration → Invoice Settings in the Recurly Admin Console).

Note: Review the feature details before enabling Credit Invoices to fully understand this change.

We recommend connecting your Vertex account to Recurly before you enable your tax jurisdictions in Vertex. This will allow time to configure your Recurly account for taxes before you begin collecting taxes in those jurisdictions.

If you meet the prerequisites and have a Vertex O Series or Vertex Cloud account, follow these steps to enable Vertex for your Recurly site:

  1. Contact Recurly Support to request the Vertex option for your site.
  2. After Recurly Support has enabled Vertex for your site, navigate to the Taxes section in the left-hand panel.
  3. Click “Connect to Vertex” in the right sidebar.
  4. Have your Vertex Endpoint, Trusted ID, Company, Division, and Version ready, and enter these values on the form:
    1. Endpoint: Enter the URL where your WSDL is hosted, up to the ".com" part. You must provide a secure HTTPS URL. For example, if your URL is, then enter Recurly will append the /vertex-ws/services/CalculateTax90?wsdl to the end of your URL and replace 9.0 with 8.0 or 7.0 depending on the version you select. Check our IP Allowlist documentation for IP addresses to allow through.
    2. Trusted Id: Every Vertex instance has a trusted ID, which is your API password. Recurly doesn't use a username and password to ensure your tax collection isn't shut off due to a user lockout or accidental password reset or deletion. If you're unsure about your Trusted Id, contact Vertex.
    3. Company: This represents the taxpayer in your Vertex instance with jurisdiction rules that apply to your invoices. If you have a division, this is the parent taxpayer.
    4. Division: This is the child taxpayer in your Vertex instance. If you have a division, it's likely that this taxpayer has jurisdiction rules that apply to your invoices.
    5. Version: The Recurly Vertex integration currently supports O Series or Cloud 7.0, 8.0, or 9.0. Select your version.
  5. Click Save Changes.
  6. Test the connection by clicking the Test Configuration button to ensure successful integration.