m3terDocumentation
Schedule a demoLog In

On this page

Configuring AWS Marketplace Integrations

You can define and manage native integrations for sending your end customer Account Bills generated in m3ter outbound into AWS Marketplace:

Note: AWS Marketplace Integration in Beta Release! Please note that the AWS Marketplace native integration is currently in beta release. If you intend to implement this integration for your m3ter Organization, please contact m3ter Support or your m3ter contact person to discuss. See section 7. of our Terms of Service for Beta Usage.

Tip: Reconciliation Features! m3ter offers two useful reconciliation features specifically designed to support AWS Marketplace integrations. See AWS Marketplace Integrations - Reconciliation Features for more details.

Completing Prerequisites

This section provides guidance on completing some necessary prerequisites for your m3ter integration to successfully send out Bills to AWS Marketplace:

Completing AWS Prerequisites

The native m3ter AWS Marketplace integration makes use of a combination of the product code and pricing dimension key to identify the correct dimensions in your AWS Marketplace account that billing data will be sent to. You'll need this product code/dimension key to hand when creating your AWS integration.

To check the product code/dimension key in AWS Marketplace:

1. In your AWS Marketplace account, go to Home>SaaS Products:

2. Open the Marketplace product you'll use for your m3ter integration - in this example M3ter SaaS Alpha Test:

3. Under Product summary read-off the Product code and under Pricing configuration the Pricing dimension you want to use for your m3ter AWS Marketplace integration:

  • In this example, the required format for the product code/dimension key will be:

    • 78qogxeqwt7zyevfefsw6q48i-measurements

Completing External Mappings

There are External Mapping you must configure in m3ter to support your AWS Marketplace integration.

Tip: More on External Mappings? See Creating and Managing External Mappings for more details.

Account Mappings

Whenever an end customer subscribes to a Marketplace product, AWS provides a customer identifier which m3ter needs to know in order to meter against it. So, an External Mapping needs to be set for an m3ter Account to the AWS Customer:

  • First, Select mapping type:

  • Second, Add mapping IDs:

Usage Line Item Mappings

Depending on how you want to split Bill usage line items for your integration, you might also need to set up some additional External Mappings.

Item Per Product

With this option selected, you'll need to set up external mappings for each product. m3ter will then send the total of all line items for a given product over to its mapped AWS Marketplace dimension:

Item Per Aggregation

With this option selected, it’s necessary to set up external mappings for each aggregation. m3ter will then send the total of all line items for a given aggregation over to its mapped AWS Marketplace dimension:

Creating the Integration

You can quickly set up a native AWS Marketplace integration in the Console.

To define a m3ter - AWS Marketplace integration:

1. Select Integrations:

The Integrations page opens.

2. Select Marketplace:

3. Select AWS:

The Integrations>AWS page opens.

4. On the Configurations panel, select Configure new integration>Configure bill integration:

5. Use the Global configuration panel to:

  • Enter a Name for the Integration. This is required and is useful if you intend to create multiple Integrations for the same External system/Entity Type and need to clearly differentiate them.

  • Select the Accounts you want the integration to apply to:

    • Account ids. Select the Accounts you want to include - all selected Accounts are treated as allowed for the integration.

    • Restricted account ids. Select the Accounts you want to exclude - all selected Accounts are treated as disallowed for the integration.

Notes:

  • If you want to include all Accounts in the integration, leave both Accounts ids and Restricted account ids empty.

  • Any filtering by Account ids you define using these settings to control which Accounts the integration runs for will be in addition to any filtering you define using the Account filter option - see the following step for Entity configuration options.

  • Select Users for Email notifications if disabled:

    • Integration disabled notification users. Select Organization Users you want to receive an Email notification if the integration is automatically disabled.

Notes:

  • An integration is automatically disabled if there have been 20 successive previous error Event responses to earlier attempts to run the integration. See Reviewing and Resolving Integration Events for more details.

  • If you select Organization Users to receive an Email notification when the integration is automatically disabled, their User id will be listed under Configuration data on the Integration details page.

6. Use the Entity configuration panel to configure the m3ter entity you will be synchronizing with for the integration. In the case of a Bill integration, this entity will be the Bill generated for a customer Account in m3ter:

  • Only send bill on approval. Enable this if you only want Bills to be sent when they have been approved. If disabled, the Bill will be sent every time it is regenerated. Default is disabled. Note that:

    • The frequency of Bills sent will depend on the billing frequency defined for the Account Plan attached to the Account - such as daily/weekly/monthly/annually.

    • If an Account has a Prepayment on it and the billing for Prepayment fees is configured to run on a customized schedule, Bills will be sent when scheduled Bills are generated.

    • If a Bill is manually recalculated the updated Bill will be sent.

    • If you enable this, then the integration will not run for all Bill Jobs.

  • Use external mapping account code. Enable this if you want the integration to look in the External Mappings for the Account identifier code, which means you can use an external Id. If this is disabled, the m3ter Account Id is used. Default is disabled.

  • Excluded line item types. Optionally filter the Bill line items you send to the destination system. For example, only send charges or credits and exclude all other line items.

  • Account filter. Optionally, enter an expression that is run on the Account to determine whether or not the integration is run. You can use this setting if you have multiple destinations for sending Bills outbound to AWS Marketplace. For example:

    • customFields != null AND customFields.country = = UK

    • In this example, the integration will run for an Account only if you have created a Custom Field for the Account called country and given the field a value of UK.

Notes:

  • Other Account fields for Account filter expression? You can reference other fields on the Account object in the Account filter expression. For details and another example, see Managing Multiple Third Party Destinations for Integrations.

  • Additional filtering? Any global filtering you define using the settings to include/exclude Accounts for integration runs by Account ids will be in addition to any filtering you define using the Account filter option - see the previous step for Global Configuration.

  • Enforce external mappings for config. Optionally enable this if you want the integration to use only those external mappings specified as being for this configuration.

    • Use this setting if you want to set up multiple integrations for the same external system. You can then create separate external mappings for each integration from the details page of each integration, and these external mappings become Linked external mappings for the specific integration. See Creating Linked External Mappings.

7. Use the External system configuration panel to enter the settings specific to the external system. These settings include field mappings as well as other system-specific configurations:

  • Split usage line items. Select how you want m3ter to create usage invoice items in AWS Marketplace. Three options:

    • Item per bill.

    • Item per product.

    • Item per aggregation.

  • Marketplace bill dimension. Determines what AWS Marketplace dimension the bill will be mapped to:

Important: Split usage line item requirements!

  • Item Per Bill selected. In Marketplace bill dimension you must enter the product code/dimension key for the dimension you want to use in your AWS Marketplace instance for sending Bill data. See above Completing AWS Prerequisites.

  • Item per product or Item per aggregation selected. You must set up required External Mappings - see above Usage Line Item Mappings.

  • Note that if you've selected Item per product or Item per aggregation, then Marketplace bill dimension is not required.

  • Aws marketplace cloudtrail checks. Enable this switch if you want to run additional checks using the AWS CloudTrail event store:

    • Aws marketplace cloudtrail store id. AWS CloudTrail event store id - used to run additional checks on usage submitted to AWS Marketplace.

    • Aws marketplace cloudtrail region. AWS CloudTrail event store region - used to run additional checks on usage submitted to AWS Marketplace.

8. Select Create integration. You are returned to the Integrations>AWS page, where the integration is listed on the Configurations panel:

Setting Up Authentication for the Integration

When you have created an AWS Marketplace integration, you can select an integration Credential you've created for authentication allowing the integration to connect with AWS Marketplace. See Creating AWS Marketplace Integration Credentials.

To set up authentication for your m3ter - AWS Marketplace integration:

1. Select Integrations. The Integrations page opens.

2. Select Marketplace:

3. Select AWS. The Integrations>AWS page opens.

4. On the Configurations panel, select the Name hotlink text of the AWS Marketplace integration you want to set up authentication for. The Integration details page opens:

  • Notes:

    • A warning is shown that the integration is not yet connected to AWS Marketplace.

    • The ID of the integration configuration is shown at the bottom of the Integration details card, and you can copy the ID directly to your clipboard.

4. Select Connect credential. A Select credential modal appears.

5. Select a Credential you created earlier and want to use to authenticate the integration with AWS Marketplace. See Creating AWS Marketplace Integration Credentials.

6. Select Confirm. The modal closes and on Integrations details, the integration now shows as CONNECTED:

  • The Credential used to connect the integration is shown.

  • If at any time you want to disconnect the integration, select Disconnect credential.

  • If you want to use a different Credential for connecting the integration, select Change credential. The Select credential modal appears and you can select a different Credential.

Tip: Integrations API Calls? When you have set up your NetSuite integration, you can review and manage the integration using a full set of API Calls. See the Integrations section of our API Reference Docs.

Next: AWS Marketplace Integrations - Reconciliation Features


Additional Support

Login to the Support portal for additional help and to send questions to our Support team.