Prerequisites
Before you begin, make sure you have:- A Metronome account with at least one production environment configured
- A Stripe account with access to the Stripe Dashboard
- The Stripe integration configured in Metronome
INFOThe Metronome Stripe App manages contracts and customers through Metronome’s interface embedded in the Stripe Dashboard. Invoicing still flows through Metronome’s native Stripe integration. Set up the Stripe invoicing integration first to ensure invoices created by your contracts reach Stripe.
Install the app
- Go to the Metronome listing on the Stripe App Marketplace.
- Click Install app and follow the prompts.
- After installation, the Metronome app is accessible from the Stripe Dashboard.
Sign in to Metronome
After installing the app, sign in to connect your Metronome account:- Open the Metronome app from the Stripe Dashboard.
- Click Sign in to Metronome.
- Complete the authentication flow.
Overview dashboard
The Overview tab provides a snapshot of your usage-based billing:- Total revenue: All-time billed amount across your Metronome contracts.
- Revenue last month: Billed amount for the most recent billing period.
- Top products: Your highest-revenue products, with remaining products grouped under “Other.”
- Usage events: A 30-day trend of usage events ingested by Metronome, with separate series for total and duplicate events.
- Customers: New customers added in the last month.
Manage customers
The Customers tab displays all Stripe customers that are linked to Metronome customers. For each customer, the app shows:- Date created: When the customer was added based on the Stripe creation date.
- Lifetime billings: Total amount billed to the customer.
- Provision status: The state of the customer’s contracts — Active, Active Soon, or Recently Ended.
- View Customer in Stripe to see their full Stripe profile.
- Manage in Metronome to open the customer in the Metronome dashboard for advanced configuration.
- Create Contract to start the contract creation flow for that customer.
Customer detail view
When you view a Stripe customer’s detail page, the Metronome module displays all contracts linked to that customer. Each contract shows the contract name (falling back to the rate card name if unnamed), the contract period with an “(Active)” indicator when applicable, and the products included in the contract. If the Stripe customer does not yet have a corresponding Metronome customer, the app automatically creates one using the Stripe customer name when you initiate contract creation.Create a contract
The contract creation flow is a four-step wizard that guides you through building a usage-based contract.Step 1: Invoicing
Configure the core contract terms:- Contract name: A descriptive name for the contract.
- Start date: When the contract begins. Defaults to today.
- End date (optional): When the contract ends. Leave blank for open-ended contracts.
- Invoice schedule: How often usage invoices are generated — Monthly, Quarterly, Annual, or Weekly.
- Send on: When invoices are sent — the 1st of the month or the contract start date.
- Net payment terms: The number of days a customer has to pay after an invoice is issued. Defaults to 30.
Step 2: Pricing
Select a rate card and optionally customize pricing for this contract:- Rate card: Choose from your configured Metronome rate cards. The rate card defines the base pricing for all products on the contract.
- Price overrides: Apply discount percentages to specific products, scoped by product tags and date range.
- Subscription quantities: If the rate card includes subscription products, set the initial quantity for each subscription line item.
- Prices: After selecting a rate card, view a summary of all products and their effective prices, including any overrides applied. You can check or uncheck individual products to override their entitlement on this contract.
Step 3: Credits
Add credits to the contract.- Credit: The name that will be used on the invoice line item when this credit is applied. (This comes from a Fixed Product defined in Metronome.)
- Applicable product tags (optional): Restrict which products can draw from this credit. If omitted, all usage products on the contract consume the credit.
- Schedule: How [credits](/guides/pricing-packaging/apply-credits-and-commits/create-a-pre-paid-commit) are allocated:
- One-time: A single allocation with a start date and end date.
- Monthly: A recurring allocation with a start date and optional end date.
- Custom: Multiple segments, each with its own start date, end date, and amounts.
- Invoice amount: What the customer is charged for the credit.
- Credit amount: The usage amount the customer receives.
Step 4: Confirmation
Click Create contract to finalize. The contract is created with the Stripe customer’s existing billing provider configuration, so invoices flow to Stripe automatically.Troubleshooting
Authentication errors
If you see “There was an error signing in to Metronome,” try these steps:- Go to the app Settings page and click Clear cached Metronome credentials under Developer settings.
- Go to app.metronome.com/logout and log out.
- Navigate back to the Metronome Stripe App and click “Sign in”
Missing customers
The Customers tab only displays Stripe customers that have a corresponding Metronome customer linked via the Stripe billing configuration in the currently connected Metronome account. If a customer doesn’t appear:- Verify you are logged in to the correct Metronome account.
- See Authentication errors above to sign out and sign back in
- Verify the customer exists in Metronome with a Stripe billing configuration.
- Confirm the
stripe_customer_idin the Metronome billing configuration matches the Stripe customer ID.