• Home

Knowledge Index

Use this index listing to quickly find information about specific m3ter entities or areas of functionality.

Accounts

Represents one of your end-customer accounts:

• attaching Plans to

• attaching Plan Groups to

• billing for Parent/Child accounts

• creating and managing

  • creating Balances for

  • creating Child Accounts for

  • creating Contracts for

  • creating Custom Plans for

  • creating Custom Plan Groups for

  • creating Prepayments for

  • creating External Mappings for

• reviewing Bills for

• submitting usage data for

Account Plans

Plans are attached to Accounts to create Account Plans, which then determine the charges incurred by your end customer.

• creating by attaching Plan to Account

• defining active period for Account

Account Plan Groups

Plan Groups are attached to Accounts to create Account Plan Groups, which then determine the charges incurred by your end customer.

• creating by attaching Plan Group to Account

• defining active period for Account

Aggregations

Aggregations define how to convert into a single number individual usage data measurements collected by Meter fields. They are used to configure pricing for Product Plans.

• creating

  • creating Compound Aggregations

  • creating Segmented Aggregations

• defining aggregation method for:

  • Use Sum of values

  • Use Min or Max values

  • Use Count of number of values

  • Use Mean of Values

  • Use Latest value

  • Use Count of Unique values

• global aggregations

• pricing Plans with

• reviewing options for

APIs

• call for submitting usage data

• getting started with

• http error codes returned

• limits for Ingest API

• limits for Config API

• optimizing Ingest submissions

• reference docs

• supported APIs

Balances

Balances are created for end customer Accounts. A credit Balance amount can then be draw-down against for any charges due throughout the period the Balance is active for the Account. Transactions can be added manually to top-up the original Balance and a Transactions ledger is maintained for the Balance:

• adding transactions to

• creating for accounts

• overage pricing for

• overage surcharge percentage for

• selecting charge types for

• selecting products for

• understanding charges draw-down against for billing

Bills & Billing

Bills are generated for an Account based on the usage-based pricing Plan that has been attached to the Account for charging the Account for consuming a Product. Plan Templates/Plans offer settings to control billing on Accounts that Product Plans are attached to for charging the Accounts.

• adding debit line items to bills

• adding credit line items to bills

• approving

• auto-approval for

• bill line item types explained

• bills for accounts:

  • reviewing

  • recalculating

• billing for parent/child accounts

• currency conversion rates for

• dates for billing

• downloading

• global lock date for

• locking

• managing

• reviewing bills for an account

• running

• running billing manually using modal

• scheduling

• settings for billing at organization level:

  • billing reference settings

    • bill prefix

    • bill sequence start

  • consolidate bills across billing frequencies

  • external invoice date for

  • days before due

  • scheduled bill interval

  • suppress generation of empty bills

• settings for billing using Plan Templates/Plans:

  • bill currency

  • bill frequency

  • bill interval

  • standing charge

    • standing charge interval

    • standing charge offset

  • product minimum spend

• statements for

• troubleshooting

• viewing details

• viewing history

Child Accounts

A Child Account is an Account that has a Parent Account defined. End customers with multiple Accounts can be issued with a single Bill for a Parent Account.

• creating

• reviewing Parent/Child

• billing for Parent/Child

Compound Aggregations

A Compound Aggregation allows you to define an Aggregation that is based on other (simple) Aggregations using a calculation.

• creating

• bill period variables for calculations

• referencing segmented aggregations in calculations

• referencing values and fields in calculations

• syntax for calculations

Contracts

Contracts are created for Accounts. For end customers who consume several different service or product packages, the total Contract value can be reported for accounting purposes.

• creating

• adding attached Plans/Plan Groups to

• adding Prepayments to

Currency

The currency used for billing is set at the level of your Organization or at the level of an individual Account. You can also define a different currency for your Plans at the Plan Template level. If you do this, the Organization or Account setting is used for billing and you can configure currency conversion rates to determine how charge amounts in the Plan currency are converted into Organization currency amounts.

• adding conversion rates for

• archiving

• creating and managing

• setting for Organization

• setting for Plan Templates

Custom Fields

Custom Fields allow you to attach custom data to your Organization and some other individual m3ter entities.

• adding

• referencing in meter derived field calculations

• referencing in compound aggregation calculations

• understanding and working with

Data Explorer

Data Explorer allows you to query data collected for your Organization in the m3ter platform for Usage, Billing, and Prepayments/Commitments.

• exporting query results

• querying & reviewing Billing data

• querying & reviewing Prepayments data

• querying & reviewing Usage data

• saving, updating, reusing queries

Data Fields

Data Fields are added to Meters and define a raw usage data collection fields.

• adding to meter

• types of data collected

Dates

• for billing

• for pricing

• for usage data submission

• quick reference on

• setting organization epoch dates

• setting organization timezone

Derived Fields

Derived Fields are configured for Meters and use calculations on other fields to define usage data collection fields. Calculations can reference Meter Data Fields, Custom Fields, and system timestamp fields.

• adding to meter

• examples of

• calculations for

• referencing values and fields for

• syntax for

Events and Notifications

You can use Events generated in m3ter as the basis for setting up and sending Notifications into your external systems when those Events occur and the specific conditions you've defined for triggering a Notification are satisfied:

• creating calculations for

• creating and managing

  • creating notification rules

  • linking notification rules to destinations

  • reviewing events for notifications

• event types

• understanding Events and Notifications framework

• utilizing for Notifications

External Mappings

External Mappings are mapping reference lookups, which store unique ids for matched objects across two or more systems.

• creating and managing for accounts

• creating and managing for integrations

Global Meters

Global Meters do not belong to a specific Product, and are used to set up usage-based pricing across different Products.

• creating

Integrations

Integrations exploit m3ter's open-API framework allowing you to quickly map and synchronize data held in any 3rd-party systems you use for core business operations.

• creating destinations for

• external mappings for

• native integrations in console

  • Stripe

  • Netsuite

  • Paddle

  • Chargebee

  • Quickbooks

• reviewing and resolving error Events for

• reviewing integration runs

• with Chargebee

• with Netsuite

• with Paddle

• with Quickbooks

• with Salesforce

• with Stripe

• with Xero

Meters

Meters define the Data Fields that your system will submit to the m3ter service as usage data. They can be created as Product-specific Meters or as Global Meters.

• creating

• data field options

  • Data Fields for

  • Derived Fields for

  • Custom Fields for

• options for

Notifications

You can set up Notifications to be triggered and sent into external systems on the basis of m3ter-generated Events. This includes the capability to create rule sets to define the precise conditions under which a Notification will be triggered and sent out when a specific Event occurs:

• example

• configuring

• destination and credentials for

• understanding

Organizations

An Organization represents your company as a direct customer of the m3ter service.

• editing config

• creating credit reasons for

• creating debit reasons for

• creating Service Users for

• currencies for

• granting support access

• managing

• transaction types for

• viewing details

• viewing Permission Policies

• viewing and editing Users

Permission Policies

Permission Policies allow you to control what users who have authenticated with the service are allowed to do in your Organization.

• adding to Service Users

• creating and managing

• viewing

Plans

Plans represent a pricing and billing plan for end customers who consume your products or services. They are derived from Plan Templates.

• creating

• creating custom for Accounts

• editing

• pricing

• reviewing options for:

  • billing currency

  • billing frequency

  • billing interval

  • standing charge

    • standing charge interval

    • standing charge offset

  • product minimum spend

  • ordinal ranking

• reviewing pricing options for

• understanding billing options for

• viewing details of

Plan Groups

Plan Groups allow you to group together Plans for different Products and define a minimum spend for the Group.

• adding Plans to

• example use case for

• creating

• creating custom for Accounts

• understanding billing options for

• understanding minimum spend for

Plan Templates

Plan Templates allow you to configure default billing and pricing settings for your Plans, avoiding repetition in configuration work when setting up Plans.

• creating

• editing

• pricing

• reviewing options for:

  • billing currency

  • billing frequency

  • billing interval

  • standing charge

    • standing charge interval

    • standing charge offset

  • product minimum spend

  • ordinal ranking

• reviewing pricing options for

• understanding billing options for

• viewing details of

Prepayments/Commitments

Prepayments/Commitments allow you to assign an amount to an Account that the end customer has agreed to pay over the duration of their contract with you.

• billing with plan

• billing on schedule

• creating for Account

• duplicating

• example of

• overage pricing for

• overage surcharge for

• reviewing details of

• setting draw-down charge types for

Pricing

Pricing allows you to use Aggregations to configure the cost of usage data consumed under a Plan.

• deleting

• editing priced Plans/Plan Templates

• pricing Plans/Plan Templates:

  • using negative pricing for

• removing Aggregations from

• reviewing options for

• viewing schedule for priced Plans/Plan Templates

• using segmented aggregations for

Products

Products represent the products or service that your Organization offers to end customers.

• creating

Segmented Aggregations

Segmented Aggregations allow you to segment the usage data collected by a single Meter and price your Plans by these segment values.

• billing for

• creating

• example use case for

• using to price Plans

• using wildcard values for

Service Users

Service Users represent automated processes that you want to grant direct API access to your Organization.

• adding Permission Policy to

• creating

• generating secret and access key for

• obtaining bearer token for

Usage Data

• aggregating to price by

• setting up Meters to collect

• submitting

• using timestamp to submit usage data adjustments

Users

Users represent a person you allow to authenticate with and have access to your Organization.

• creating permission policies for

• creating user groups for

• inviting to join your organization

• managing and adding permission policies to

• tracking user activity in console

• viewing and editing

Next: Authenticating with the Service