In this section · 3 articles

Monetization catalogue API reference

The read-only addresses your website or app reads active plans, their prices and your features from, with sign-in, paging, search and the fields each one returns.

Applies to
Monetization 3.0 and later
Who can do this
Developer
On this page

Overview

Monetization serves its catalogue, your active plans and features, so a website or app can show a pricing page. It's read only: nothing here starts a subscription or changes a plan.

There are two copies of the same addresses, which differ only in how the caller signs in:

SurfaceBase pathSign-in
Web/api/v1/web/module/monetization/In Core 12.7 and 12.8 none works. A signed-in Laramin session and a token from POST /api/v1/web/login both get 401.
Mobile/api/v1/mobile/module/monetization/The token your mobile app gets when its user signs in, or a personal API token.

Use the mobile addresses. Any signed-in user can call them. No Monetization permission is needed, and the answers are the same whichever business the caller works in. An anonymous visitor gets 401.

A personal API token from Account menu › API Tokens works on the mobile addresses. Send it as Authorization: Bearer <token>. The web addresses refuse it with 401, like every other caller. See Create and manage personal API tokens and Authenticate API requests.

  • Verbs: every address is GET.
  • Responses use Laramin's standard envelope: { success, message, data, meta }. Errors carry { success: false, message, … }.
  • Paging: lists take ?page= and ?per_page=. per_page is at least 1 and at most 100.
  • Empty is not an error: a catalogue with nothing active answers 200 with an empty list.
  • Names are snake_case. Dates are ISO 8601.

Plans

GET plans

Every plan whose Status is Active, ordered by Order and then slug. 20 per page by default.

The list includes Enterprise plans and plans whose Visible to is Internal. Use is_enterprise and visibility to decide what your pricing page shows.

FieldWhat it is
id, slugThe plan's id and its permanent slug. Use the slug to refer to a plan.
name, description, specificationsText in the caller's language when a translation exists.
statusAlways active here.
sort_orderOrder on the plan form.
visibilityThe stored code, such as fvby_public or fvby_internal, or null.
is_featured, is_enterprise, is_default, is_tax_applicableThe plan's Featured, Enterprise, Default and Taxable switches.
region_id, region_keyThe plan's region, or null. region_key is the country and state, such as IN:Karnataka, or IN:__ALL__ for a whole country.
imageA full address for the plan's Image, or null.
pricingsThe plan's active prices. See below.
created_at, updated_atWhen the plan was created and last changed.

Each entry in pricings:

FieldWhat it is
currency_codeSuch as INR.
interval, interval_countday, week, month, quarter or year, and how many of them. month with 3 means every three months.
price_minor, priceThe price in the currency's smallest unit (an integer), and the same price as a decimal string. Use price_minor for sums. Not every currency has two decimals: JPY has none and OMR has three.
setup_fee_minorThe Setup fee, in the smallest unit.
trial_periodTrial days, or null.

A plan's entitlements (which features it includes and their values) aren't part of this response.

Features

MethodPathReturns
GET
/api/v1/web/module/monetization/features
/api/v1/mobile/module/monetization/features
Every active feature, ordered by slug. 15 per page by default.
GET
/api/v1/web/module/monetization/features/search?keyword=
/api/v1/mobile/module/monetization/features/search?keyword=
Active features whose slug or Internal title contains the keyword. 10 per page by default. Without keyword, 422 with A keyword is required.
GET
/api/v1/web/module/monetization/feature?slug=
/api/v1/mobile/module/monetization/feature?slug=
One active feature. Without slug, 422 with A slug is required. An unknown or inactive slug answers 404 with No feature is published under that slug.

Each feature:

FieldWhat it is
id, slugThe feature's id and its permanent slug.
titleThe Internal title, for your team.
labelThe Customer label: what to show on a pricing card. Can be null.
descriptionThe feature's description.
statusAlways active here.
unit_typeThe stored code of the kind of value, such as futs_number or futs_boolean.
unitWhat the number counts, such as GB, or null.
visibility, flagStored codes, such as fvby_public and fflg_beta, or null.
default_valueDefault value, or null.
is_usage_metrictrue when the feature is Metered.
scopeAlways monetization.root for features created on screen.
created_at, updated_atWhen the feature was created and last changed.

The stored codes start with futs_, fvby_ and fflg_ on purpose. Compare them as they are, and don't strip the prefix.

Example

HTTP
GET /api/v1/mobile/module/monetization/plans?per_page=10
Accept: application/json
Authorization: Bearer <token>

Replace the highlighted values with your own.

JSON
{
  "success": true,
  "message": "Success",
  "data": [
    {
      "id": 4,
      "name": "Growth",
      "slug": "growth",
      "status": "active",
      "is_enterprise": false,
      "region_key": "IN:__ALL__",
      "pricings": [
        { "currency_code": "INR", "interval": "month", "interval_count": 1,
          "price_minor": 149900, "price": "1499.00", "setup_fee_minor": 0, "trial_period": 14 }
      ]
    }
  ]
}

Fields are shortened in this example.