Payment-gated commits

1. Metronome immediately triggers a payment attempt based on the invoice amount of the commit.
2. If the payment succeeds, Metronome releases the commit and the customer is granted access to the associated balance.
3. If the payment fails, Metronome voids the resource and sends a webhook notification.
4. If further action is required (e.g. for 2F authentication), Metronome sends a webhook notification.

​

Before you begin

• If using Stripe as the payment provider, ensure the customer has a default payment method specified and a valid stored customer address. Otherwise, payments will fail and commits will not be created.
• If using an External payment provider, make sure you have all required information is stored in that system.
• Map the Metronome commit product to the associated Stripe product. Without this mapping, the payment attempt will fail. To configure this mapping, create a stripe_product_id custom field on the Metronome product entity, set its value to the corresponding Stripe Product ID, and add a Stripe integration mapping rule from stripe_product_id to invoiceitem.price. See Assign line items to Stripe products in the Stripe invoicing guide for step-by-step instructions.

​

Add a payment-gated commit to an existing contract​

{
    "customer_id": "8cecbf69-960f-4f66-9575-edebb7d95e88",
    "contract_id": "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
    "add_commits": [
        {
            "product_id": "d6be3bf4-1669-40c9-a8b1-388bb167ab16",
            "type": "prepaid",
            "invoice_schedule": {
                "schedule_items": [
                    {
                        "timestamp": "2025-04-01T00:00:00.000Z",
                        "amount": 2000
                    }
                ]
            },
            "access_schedule": {
                "schedule_items": [
                    {
                        "amount": 2000,
                        "starting_at": "2025-04-01T00:00:00.000Z",
                        "ending_before": "2026-04-01T00:00:00.000Z"
                    }
                ]
            },
            "payment_gate_config": {
                "payment_gate_type": "STRIPE",
                "tax_type": "STRIPE"
            },
            "priority": 100
        }
    ]
}

​

Manage notifications​

• payment_gate.payment_status after payment has been attempted. The status of that payment, paid or failed , is denoted in the payment_status field.
• payment_gate.payment_pending_action_required if intervention is required to process payment.

​

Handle failed payments​