Sales Tax
Depending on where you are based, you may need to add tax to the cost of your subscriptions. If you use Braintree as a payment provider, you can set up a sales tax through Zephr.
When configured, the sales tax amount displays in the format $x + $y (tax)
To configure a sales tax for Braintree payments, you must do the following
- Configure the tax in Braintree
- Configure the tax in Zephr
Once configured, you can test the sales tax, as described in the Test the Sales Tax section.
Configure Sales Tax in Braintree
To configure a sales tax in Braintree, complete the following steps:
- Login to your Braintree account
- Select Subscriptions
- Select Add Ons/Discounts
- Select Create an Add-On
- Enter the following information for your add on:
- ID
- Name
- Optionally, Description
- Set the Add On amount to 1Note: Zephr uses the Add On based on a percentage of the purchase price, so you can set this amount field to any figure. For further information on configuring the sales tax in Zephr, see the Configure Sales Tax in Zephr topic
- In the Duration selection, select whether the charge applies to the duration of the subscription, or for a set number of billing cyclesNote: A sales tax is likely to be needed for the Duration of the Subscription
- Select CreateThe Add On Details display.
- Note the Add On IDYou might have set this, or it might have been randomly generated.
Configure Sales Tax in Zephr
To configure a sales tax in Zephr, complete the following steps:
- Select the Settings icon, which is located at the top right of all screens
- Select ExtensionsThe Extensions screen displays.
- Scroll to the Internal section
- Select Sales TaxThe Sales Tax screen displays, as illustrated below:
- Select the Configuration buttonThe Configuration screen displays, as illustrated below:
Complete the Configuration screen as follows:
- Enter your Braintree Add On ID in the Braintree Addon ID text box
- Enter your Tax Label in the Tax Label text boxThis label is used to explain the additional amount on the price of your subscription.
- Enter the user attribute used to determine whether a user sees prices with the tax add-on in the User Attribute Field text box. For example, you may select State, to charge tax to users in particular US statesThe details look similar to the following:
- Select the Done button to save the configuration and return to the Sales Tax screen. Selecting the Cancel button displays the Sales Tax screen without saving the configuration
- Select the User Attribute Mapping buttonThe User Attribute Mapping screen displays, as illustrated below:
Complete the User Attribute Mapping screen as follows:
- Enter the user attribute values to map to a tax percentage in the User Attribute Values to Tax Percentage Mapping text boxFor example, the following entry means that users from New York State must pay 10% tax on their subscriptions:
{“NY”:”10”}
This is entered is as illustrated below:
- Select the Done button to save the user attribute mapping and return to the Sales Tax screen. Selecting the Cancel button displays the Sales Tax screen without saving the user attribute mapping
- Enter the user attribute values to map to a tax percentage in the User Attribute Values to Tax Percentage Mapping text boxFor example, the following entry means that users from New York State must pay 10% tax on their subscriptions:
- Select the toggles beside each site for which you want to activate the plugin, as illustrated below. Alternatively, select the Select All Sites toggle to activate the plugin on all your sites
- Select the Save button
Your plugin is now enabled and is used in the specified sites.
Test the Sales Tax
You can test the plugin as follows:
- Register as a user and specify NY as your state
- Navigate to a payment pageYou see any subscription prices with an additional 10% added for tax.
- Register as a user and specify a different state
- Navigate to a payment pageYou see the usual price.