LogoLogo
  • Welcome to Subscribe
    • Introduction to Subscribe
    • Subscribe Release Notes
      • 2025.1
      • 3.17.0 Major Release
        • 3.17.0.x Hotfixes
        • 3.17.1 Minor Release
          • 3.17.1.x Hotfixes
        • 3.17.2 Minor Release
      • 3.16.0
        • 3.16.0.X Hotfixes
        • 3.16.1 Minor Release
          • 3.16.1.X Hotfixes
        • 3.16.2 Minor Release
          • 3.16.2.X Hotfixes
        • 3.16.3 Minor Release
          • 3.16.3.x Hotfixes
      • 3.15.0 and 3.15+
      • 3.14 and 3.14+
      • 3.13.0 and 3.13+
      • 3.12
      • 3.11
      • 3.10
      • 2.X Releases
    • Coming Soon: What's On Your Way
    • NCS Circ Service Packs
      • 2018.5 Service Pack 1
      • 2018.5 Service Pack 2
      • 2018.5 Service Pack 3
      • 2018.5 Service Pack 4
      • 2020.2.0 Version
      • 2020.2.1 Version
      • 2020.2.2 Version
      • 2020.3.0 Version
      • 2020.4.0 Version
        • 2020.4.0 Version - Resolved Issues
        • 2020.4.0 - Enhancements
  • Naviga Applications and User Guides
    • Landing Application User Guide
      • Create a New User
      • Editing User Details
      • Exporting the Users
      • Password Settings
    • Solicitor Concierge User Guide
      • Solicitor Quickstart
      • Find your way around the Solicitor UI
      • Tutorials
        • Audit Trail
        • Configure available areas
        • Configure a sales product
        • Configure marketing text
        • Configure terms and conditions
        • Configure premiums
        • Configure an offer group
        • Configure an activation fee
        • Configure users, sales teams, and team members
          • Best practices for user accounts
          • Roles and permissions matrix
        • Import or Export Solicitor Data
        • Reference tables
    • CSR User Guide
      • Account information
      • Subscription Search
      • New Subscription Registration
      • Sending Invites
      • Create a new subscription
      • Digital Product Management
      • Disclaimer Management
      • Registration Management
      • NCS Only
        • Delivery Issues and Delivery Management
        • Billing and payment management
        • Address management
        • Update Solicitation Preference
        • Upgrades and downgrades management
        • Temporarily stop a subscription
        • Permanently stop a subscription
        • Create a vacation transfer
        • Redirect to classic portal
        • Restart a Subscription
      • Matrix Only
        • Billing and payment management
      • Show events and access events
    • Subscription Panel User Guide
      • Overview
      • Tutorials, how-tos, and reference documentation
        • Component Matrix
        • Create, edit, or remove component properties
          • Common properties quickstart
        • Create, edit, or delete a Presentation Template
        • Create, edit, delete, import or export Presentations
        • Preview a Presentation
        • Tutorials and Step-by-step guides
        • Reference documentation
          • Analytics
          • Presentation URLs
    • CMS User Guide
      • Overview
      • Tutorials, how-tos
        • How to Create a New Page
        • How to Manage Attributes
        • How to Manage Benefits
        • How to Manage Rewards
        • How to Manage Content and Pages
        • How to Manage the FAQ Section
        • How to Manage Images
        • How to Manage Slideshows
        • How to Manage Navigation: Links, Menu, Footer
        • How to Manage Notifications
        • How to Manage Newspapers (Divisions) And Newspaper Groups
  • Subscribe Features
    • New Starts and Restarts
      • Active Subscription Check
      • New starts
        • Complimentary (free-of-charge) subscriptions
        • 'Day Pass' Subscriptions (NCS Circ)
        • Gift Subscriptions (NCS Circ)
        • Lite Subscriptions
        • Trial-with-Payment subscriptions (NCS Circ)
        • Country-Only-Start Subscriptions (NCS Circ)
        • Auth0 Email Verification
      • Occupant creation/update during a new start (NCS Circ)
      • PurchaseAPI and failed starts reprocessing
      • Restarts (NCS Circ)
      • Restarts (Matrix)
    • Payment features (NCS Circ)
      • Tip: One-time and Recurring (NCS Circ)
      • Activation fees (NCS Circ)
      • One-time payment and Auto-renew (NCS circ)
      • Apple Pay: NCS Circ, Payway & Braintree
      • Google Pay: NCS Circ, Payway / Braintree
      • Variable Pricing (NCS Circ)
    • Upgrades and Downgrades
    • Stop Saver (NCS Circ)
    • Multicurrency (Vindicia only)
      • Multicurrency set up user guide
    • Occupant data update
  • ADDITIONAL RESOURCES
    • Subscribe APIs
      • Newsletter Widget API
      • InApp API (External Payments)
      • Newstart InApp (Webhooks)
      • Subscription API
      • Entitlements API Reference
      • Firefly
    • Workflows
      • Make a Payment Workflow
      • Auto-renew Workflows
      • NCS Only
        • eBill Workflows
        • Vacation Transfer Workflow
        • Permanent Stop Workflow
        • Temporary Stop Workflow
        • Solicitation Preference Workflow
        • Delivery Issues Workflow
        • Address Management Workflow
        • Restarts
        • Subscription Purchase Workflows
      • Matrix Only
        • New Start (Matrix)
      • CircPro Only
        • New start Workflow
        • Complaints Workflow
        • Update Payment Information Workflow
        • Switch to Invoice Workflow
        • One Time Payment Workflow
        • Temporary Stop Workflow
      • New Start Flow
      • Move Flow
    • Videos & Webinars
Powered by GitBook
On this page
  • Overview
  • Glossary
  • Business requirements
  • Development details
  • Pre-requisites
  • The list of the work required

Was this helpful?

Export as PDF
  1. Subscribe Features

Multicurrency (Vindicia only)

DISCLAIMER

Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.

Overview

The Multicurrency feature allows our applications to provide dynamic pricing. This enhancement changes currency UI (symbol and formatting) and supports different price points and tax amounts. Only digital (ZIP-only) new starts are supported in scope of this feature

This feature will cover the following needs:

  • users can now purchase products in their desired currency, local or other. Country related taxes will be displayed along with the cost in the respective currency)

  • prices at a product and bill plan level can be set in different currencies

Please note that this is a breaking change: for the create inApp subscription calls now you need to send the Currency (required field) on the request Body

Glossary

  • Selected by user (respective) currency - the country-dependent currency selected by the end-user. When a user enters their billing country/postal code their corresponding currency is selected. If there are several currencies supported within the country, the user will need to select one from the list of what their country supports.

  • Price cycle - Price for a billing Period. The price within the active billing period cannot be changed; Vindicia specific

Business requirements

  1. In all applications, prices are displayed in the end-user's selected currency + symbol.

  2. In all applications, VAT or related taxes are displayed in the end-user's selected currency + symbol.

  3. In all applications, the total subscription cost is displayed in the end-user's currency + symbol.

    1. All user-facing and admin-facing pages (e.g. current subscription information, transaction history) should have the prices displayed in the currency + symbol that the end-user selected.

    2. The transactional emails should have the prices displayed in the currency + symbol that the end-user selected.

  4. Local (respective) currency is determined by the country the user entered:

    1. The currency gets populated automatically after the user selects a country if the subscriber concierge database has only one currency stored for the selected country.

    2. The user is prompted to select a currency if the user selects a country that has more than one currency set at the country level in subscribe concierge database.

    3. Both price and currency symbol gets updated each time country/currency is updated.

  5. Vindicia processes the payment in the selected currency.

  6. When creating an auto-bill, the pricing is displayed in the currency + symbol the end-user selected, the exact cost is pulled from the billing plan where it should be set in that currency.

  7. Additional currencies can be added to active billing plans (the ones with active subscriptions) but will only be applied in the next billing cycle, the price/currency set for the current price cycle on that billing stays unchanged.

  8. The pricing in the billing plans can be set independently for each currency.

  9. All the current payment methods should be supported (both PayPal and credit cards).

  10. In case of errors caused by incorrect/incomplete configuration, the default currency + symbol (USD and `$`) will be used.

  11. An error message is displayed in SubCon Admin in case currency isn’t defined.

Development details

Pre-requisites

  1. The price needs to be set at the Billing Plan level for each currency. The currency must also exist at the product level but the price should be 0 at the product level for each supported currency type.

  2. Both the list of the supported currencies and their appropriate symbols needs to exist in the database

The list of the work required

  • The presentation has a single-selection dropdown for countries and a field for the related currency symbol.

  • Whenever a different billing country is selected, the pricing (including both the currency and the symbol) updates automatically.

  • The Subscription Panel displays total subscription costs in the currency the user selects.

  • The Subscription Panel makes a dry run call to Vindicia to get the correct product, bill plan, and tax using the selected currency and address. Both price and tax will be displayed in culture-based format.

  • Currency is passed in the cart abandonment analytics.

  • Step component in CMS needs to be enhanced with the field to control the displayed currency.

  • The `Next Payment info` section contains the proper currency symbol.

  • The `Invoices` table contains the proper currency symbol.

  • The currency and its corresponding symbol are shown correctly on each page level (please pay attention to account-related pages).

  • The Subscription Panel will display to the user the total subscription cost in local currency. To do this, the `DryRun` endpoint will be updated to receive the currency. The endpoint will then simulate the subscription creation and return the subscription cost.

  • `SubscriptionAPI` receives the Currency as part of the input model when performing the CreateAutoBill call. If the currency is not provided, then a default value from MG2 Control is used.

  • `CurrencyCode` (mapped from Subscriptions table) and `CurrencySign` (mapped from Currencies) are added to the Subscription object.

  • `GET Currencies` endpoint is updated to have two input parameters: `CurrencyCode` and `CountryCode`. The endpoint returns the list of currencies (may consist of only one value).

  • GETPRODUCTS (1037) and GETPRODUCTBYID (1040) events should be created for GET /Products and GET /Products/Filtered endpoints for Vindicia in real-time

  • In the `Product` section, the `Currency edit` drop-down field on the form is replaced by a `Prices` grid. which contains ‘Currency’ and ‘Price’ columns with Edit, Save and Cancel functionality for each

  • In the ‘Prices’ grid of the ‘Product' section, the price can be set independently for each currency (no exchange rate is applied automatically).

  • In the ‘Billing Information’ section, the ‘Price edit’ field was replaced by the new ‘Prices’ grid: which contains expandable ‘Price cycles’ that have Edit, Save, and Cancel functionality.

  • The price can be set independently for each currency.

  • Subscription Search, Subscriber Search, Reports, Billing Plans, and Products Management pages are updated with the ability to display Subscription’s currency (not USD only) together with the appropriate local currency symbols.

  • Going forward, applications will get the dynamic currency sign via APIs as opposed to always using a static USD symbol.

  • In case of the error where the currency of the transaction is not returned from the API, we use the default currency (USD) and the appropriate default currency symbol '$'. An edge case would happen only if the configuration is not complete/correct

  • If more than one currency is found when syncing billing plan and product from:

    • Vindicia - then all the currencies except USD should be ignored (currency and amount stay blank in the case where is no USD price for Product and BillingPlan). Sync processes that populate the Subscription Panel including the Payment Method table should be updated to sync all the currencies.

    • Update Subscriber Concierge database to store Countries and related currency/s (Country_currency table Currencies table should have a 1-to-many relationship)

PreviousStop Saver (NCS Circ)NextMulticurrency set up user guide

Last updated 1 year ago

Was this helpful?