Configuring Stripe Integrations - m3ter Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

You can define and manage integrations for sending your end-customer Account Bills generated in m3ter outbound into your Stripe system:

• First, create the integration.
• Second, set up authentication for the integration to connect with Stripe.

Creating the Integration

You can quickly set up a Stripe integration in the Console.

Important! Notes and Warnings:

• Note: Stripe or Stripe (Test mode)? The difference between these two integrations is: selecting Stripe means an integration destination into your Stripe production environment; selecting Stripe (Test mode) means an integration destination into your Stripe test environment. The configuration settings are the same for both destinations.
• Note: Accounting Products? Many line item types can be mapped to specific Accounting Products to serve your revenue recognition and accounting purposes. Where this is the case, the integration will use the assigned Accounting Products.
• Note: Reviewing Integration Runs? When you’ve set up an integration with Stripe for your Organization in your production environment, you can review details of the integration runs performed for the integration. See Reviewing Integration Run Details.
• Warning: Credit or Debit Line Items on Bills! If you have added Credit or Debit line items to Bills, then please ensure you enter Service Period start and end dates for these line items. This is a Stripe requirement and a Bills integration will not run correctly if you omit these dates.
• Warning: Managing Empty Bills! Please ensure you enable the Suppress empty bills setting for your Organization before deploying to your production environment. This means that any Account Bills without line items are not created in m3ter and are therefore not sent through as empty Bills to your Stripe system when the integration runs resulting in an error. See Viewing and Editing Organization Configuration.

To define a m3ter - Stripe integration:

1. Select Integrations:

The Integrations page opens with All selected by default.

2. Select Stripe:

The Integrations>Stripe page opens.

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

The Create page opens and the Entity type - Bill and External system - Stripe are shown at the top of the page.

4. 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.

5. 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 item types you send to the external system. For example, only send charges or credits and exclude all other line item types.

• For details of line item types, see Bill Line Item Types.

Warning: Credit and Debit line items on Bills! If you set up the integration to include CREDIT_MEMO and DEBIT_MEMO line items and you have added Credit or Debit line items to Bills, please ensure you enter service period start and end dates for these line items. This is a Stripe requirement and if you omit these dates, the integration will not run correctly. See Adding Credit Line Items to Bills and Adding Debit Line Items to Bills.

• Account filter. Optionally, enter an expression that is run on the Account to determine whether or not the integration includes the Account. You can use this setting if you have multiple destinations for sending Bills outbound to your Stripe system. For example:
  • "customFields != null AND customFields.country == "UK"
  • In this example, the integration will include 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.

• Excluded products. Optionally filter the Bill line items you send to the external system. Any line items associated with the selected Products will be be excluded when the integration runs.

• Note that if line items are mapped to a specific Accounting Products, these will be used for filtering to exclude line items.

• Excluded aggregations. Optionally filter the Bill line items you send to the external system. Any line items associated with the selected Aggregations will be be excluded when the integration runs.

6. 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:
   • **Create stripe invoice.**Enable this if you want the integration to create a Stripe invoice:
     • Set this switch to true if you are using Stripe Subscription Invoicing. Note that if you switch this to true, you can specify an invoice rendering template you want the integration to use when creating invoices in Stripe - see settings below.
     • Set this switch to false if you are using Stripe Subscriptions.
   • Price data product id. Enter the Product Id in your Stripe Product List in order to enable the integration to set tax-related fields on line items that should be sent from m3ter. Only one Product Id is required.
   • Po number custom field. Enter the name of the custom field in the Stripe system that will used for the Purchase Order number that appears in the m3ter Bill.
   • Sort line items by. Optionally, select a property to sort line items by before they are sent out to the external system. Three options:
     • None
     • Subtotal
     • Aggregation ID
   • Send due date. If you want the m3ter Bill due date to be sent through when creating Stripe invoices, enable this switch. Note that this should be disabled if Stripe is configured to automatically charge invoices. Default is disabled.
   • Split usage line items. Select how you want invoice items to be created in Stripe. Stripe charge items can be mapped to an individual usage pricing band or to a product:
     • Item per usage band
     • Item per product
   • If you want the integration to create an invoice in Stripe and have enabled Create stripe invoice, you can specify an invoice rendering template to be used:
     • Invoice rendering template id. Enter the ID of the template you want the integration to use.
     • Invoice rendering template version. Enter the version of the specified template you want the integration to use.

Tip: Stripe Invoice Rendering Templates? See the Invoice Rendering Templates topic in your Stripe documentation for more details.

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

Setting Up Authentication for the Integration

When you have created a Stripe integration, you can select a Credential you’ve created for authentication allowing the integration to connect with your Stripe system.

To set up authentication for your m3ter - Stripe integration:

1. Select Integrations. The Integrations page opens with All selected by default.
2. Select Stripe. The Integrations>Stripe page opens.
3. On the Configurations panel, select the Name hotlink text of the Stripe integration you want to set up authentication for. The Integration details page opens:

• Notes:
  • A warning is shown that the integration is DISCONNECTED from to your Stripe system.
  • 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 Stripe. See Creating Stripe 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: Testing your Integration Setup? Your Stripe integration is now available for use. However, it remains in Beta release and we strongly recommend you test the implementation in your m3ter Sandbox or QA environment before releasing it to your Production environment. See section 7. of our Terms of Service for Beta Usage.

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