In this section · 3 articles

Set up regions and their currencies

Add a region for each country, or state of one, that you price plans for, and record the currencies and languages used there.

Applies to
Monetization 3.0 and later
Who can do this
Administrator
Permission
feature.mon.region.create
Where
Monetization › Regions
On this page

A region is a place you sell in: a whole country, or one state or province of it. You give a plan a region when its prices are meant for that place, for example a Growth (India) plan priced in rupees. Regions are optional. A plan with no region is for everywhere.

Regions are shared by every business in your Laramin, like plans are.

Tip: A region has nothing to do with tax. Billing works out tax from the country and state on the customer's billing account. See How Billing works out tax.

Before you start

  • You need feature.mon.region.create, and feature.mon.region_context.create to add currencies and languages to a region. Changing them needs the matching edit permissions.
  • Decide on a short Code for each region, such as in or in-ka. You can't change it after you save.

Add a region

  1. Go to Monetization › Regions.

  2. Select New Region.

    The Create Regions drawer with Name India, Code in-ka, Country India and State or province Karnataka filled in, Default switched off and Status set to Active.
  3. In Name, enter the name your team will see, such as India. You can enter it in each of your languages.

  4. In Code, enter a unique code of up to 60 characters.

  5. In Country, choose the country.

  6. In State or province, enter the state if the region covers only one, such as Karnataka. Leave it empty for the whole country.

  7. Leave Status as Active.

  8. Select Save.

You see Region created. Code, Country and State or province can't be changed after this. To change them, add a new region and move your plans to it.

Each country and state can have only one region. A second region for the same country with an empty State or province, for example, is refused. Monetization 3.0.0 refuses it with a message that doesn't mention the duplicate: This record cannot be deleted because it is being used in another record. Nothing is saved.

The other fields are for your own records: Default, Description, Available from, Decommissioned and Order. In Monetization 3.0.0 nothing reads a region's Default, Available from or Decommissioned. A region whose decommission date has passed can still be chosen on plans.

Add its currencies and languages

  1. In the region's row, select Currencies & languages.

  2. Select New Currency or language.

    The Create Currencies & languages drawer, with Kind set to Currency and Code INR, above the Default, Priority, Status, Available from and Decommissioned fields.
  3. In Kind, choose Currency or Language.

  4. In Code, enter the ISO code, such as INR for a currency or en for a language.

  5. Turn on Default for the region's main currency, and for its main language.

  6. Optional: set a Priority, and Available from and Decommissioned dates.

  7. Leave Status as Active.

  8. Select Save.

A region has one default of each kind. Turning on Default for a new currency turns it off on the old one.

The code is stored as text, not picked from a list, so it isn't checked. Type it exactly. In Monetization 3.0.0 a region's currencies don't limit the prices you can give a plan in that region. They're a record for your team: nothing in your Laramin reads them, and the catalogue API doesn't return them.

What a region does

  • A plan can belong to one region. Choose it in the plan's Region. See Create and publish a plan.
  • Plan names are unique within a region. Two plans in the same region can't have the same Name. Plans in different regions, or with no region, can.
  • Your website can group plans by region. The catalogue API returns each plan's region as region_key, such as IN:Karnataka. See Monetization catalogue API reference.
  • A subscription remembers it. When a subscription starts, it keeps a copy of its plan's region, so later changes don't rewrite what the customer bought.

Delete a region

Select Delete on the region's row. A deleted region goes to the trash, and you can restore it. Plans keep pointing at it while it's there, but their Region shows empty.

Removing a region for good from the trash clears Region on its plans. See Delete and restore records in bulk.

Before you delete a region, move its plans to another region, or leave them with none.