Skip to main content

Documentation

Invoice Payment Succeeded Webhook

The INVOICE_PAYMENT_SUCCEEDED webhook is sent when Rapyd successfully completes accepting the payment for an invoice.

  • INVOICE_PAYMENT_SUCCEEDED Webhook

  • {
        "id": "wh_7a9f43e63dc5c1d4435bfcf55ec6bc07",
        "data": {
            "id": "invoice_d3274be6b5b83ff1a3cda9ce59e77c10",
            "tax": 0,
            "type": "payment",
            "lines": [{
                    "id": "il_fa63a2550087849d9a85325fff6e5946",
                    "plan": {
                        "id": "plan_8c14014760cac1d944ba903d606c168e",
                        "tiers": [],
                        "active": true,
                        "amount": 1,
                        "currency": "USD",
                        "interval": "day",
                        "metadata": {},
                        "nickname": "",
                        "created_at": 1700068391,
                        "tiers_mode": "",
                        "usage_type": "metered",
                        "billing_scheme": "per_unit",
                        "interval_count": 1,
                        "aggregate_usage": "sum",
                        "transform_usage": {
                            "round": "up",
                            "divide_by": 1
                        },
                        "trial_period_days": 0
                    },
                    "type": "subscription",
                    "amount": 0,
                    "period": {
                        "end": 1702574051,
                        "start": 1702487651
                    },
                    "currency": "USD",
                    "metadata": {},
                    "quantity": 0,
                    "proration": false,
                    "description": "IDV Checks",
                    "discountable": true,
                    "invoice_item": "",
                    "subscription": "sub_e11768e69c4f25f54aeb32fbbe4f0763",
                    "subscription_item": "subi_08af2d3fcfd7fd500c13ec7d5997d23e"
                }
            ],
            "total": 0,
            "payout": null,
            "status": "paid",
            "billing": "pay_automatically",
            "payment": null,
            "currency": "USD",
            "customer": "cus_97261d3e9d05bff1a65a05f8eb6e8b73",
            "discount": null,
            "due_date": 0,
            "metadata": {},
            "subtotal": 0,
            "created_at": 1702515599,
            "period_end": 1702660451,
            "description": "",
            "tax_percent": 0,
            "period_start": 1702574051,
            "subscription": "sub_e11768e69c4f25f54aeb32fbbe4f0763",
            "attempt_count": 0,
            "payout_fields": null,
            "billing_reason": "subscription_cycle",
            "days_until_due": 30,
            "payment_fields": null,
            "payment_method": "card_1ef2b450ce89f39f16f088855bae901c",
            "discount_amount": 0,
            "next_payment_attempt": null,
            "statement_descriptor": "",
            "automatic_attempt_count": 0
        },
        "type": "INVOICE_PAYMENT_SUCCEEDED",
        "status": "NEW",
        "created_at": 1702515919,
        "extended_timestamp": 1702515919834,
        "trigger_operation_id": "9cf879d7-a837-4906-b2f8-359c77cd9558"
    }