Configuring Paddle Integrations

You can define and manage native integrations for sending your end customer Account Bills generated in m3ter outbound into your Paddle system.

To create and configure a native integration, you can follow a three-stage process:

  • Stage 1. Select the Entity Type that the integration is for. Currently, only native integrations for Bills are supported.

  • Stage 2. Select the external system that is the destination for the integration.

  • Stage 3. Configure the details required for the selected integration destination and create the integration.

Note: Paddle or Paddle (Sandbox Mode)? The difference between these two integrations is selecting Paddle means an integration destination into your Paddle production environment, selecting Paddle (Sandbox Mode) means an integration destination into your Paddle Sandbox environment. The configuration settings are the same for both destinations.

To define a m3ter - Paddle integration:

1. Select Integration>Configurations. The Integration Configurations page opens and lists any existing configurations.

2. Select Create integration. The Create page opens at Stage 1: Select entity type.

3. Use the Entity Type drop-down to select the entity type you want to configure and create the integration for. Currently, only Bill is available for selection.

4. Select Continue. The page adjusts to show Stage 1 as checked and completed and shifts focus to Stage 2: Select external system as destination.

5. In the Destination drop-down list, select Paddle or Paddle (Sandbox Mode).

6. Select Continue. The page adjusts to show Stage 2 as checked and completed and shifts focus to Stage 3: Configure and create. The Entity Type and Integration Destination you've selected are shown.

7. Use the Auth Config panel to set up authorization with your Paddle system for the integration:

  • In the Vendor Id field, enter the vendor ID from the Paddle Console.

  • In the Vendor Auth Code field, enter the vendor auth code from the Paddle Console.

8. Select Update to save these credentials. Note that if you don't save them at this point in the workflow, they'll be saved along with other settings when you create the Integration Configuration.

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

Note: If you want to include all Accounts in the integration, leave both Accounts Ids and Restricted Account Ids empty.

10. Use the Entity Config panel to configure the m3ter entity you will be synchronizing with for the integration. In the case of an outbound 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, rather than Bills being sent each time they are 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.

11. Select Create. The Integration Configuration is saved and linked to your provided authentication method. Your Paddle integration is immediately available for use.

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