# Chargebee payment failed notifications on your phone

> Get a High-priority push notification when a Chargebee payment fails, with the gateway's reason, the card and the next retry date.

- Company: Chargebee (https://www.justpush.io/recipes/chargebee)
- Event: `payment_failed` (payment_failed)
- Tags: Payments & billing, Failed payments & disputes
- Install: https://studio.justpush.io/recipes/chargebee/payment-failed
- Web page: https://www.justpush.io/recipes/chargebee/payment-failed

## Setup

1. Click Install in Studio and sign in. The recipe is added to your account and you get a personal webhook URL.
2. In Chargebee, go to Settings > Configure Chargebee > API Keys and Webhooks, open the Webhooks tab and click Add Webhook.
3. Paste your webhook URL (shown in Studio after install) as the Webhook URL (add ?site=your-site for dashboard buttons).
4. Under Events to Send, pick only payment_failed and save the webhook.
5. Under **Events to Send**, pick only `payment_failed` (Chargebee selects All Events by default). It fires on each failed attempt, so a card that keeps failing during dunning can push once per retry.
6. **Dashboard button:** Chargebee events don't include your site's name, so add it to the webhook URL to get a button that opens the invoice in Chargebee. Use the part before `.chargebee.com` in your dashboard address (test sites usually end in `-test`):
7. ```
8. your webhook URL (shown in Studio after install)?site=your-site
9. ```
10. Without `?site=` the push arrives without a button.
11. Built for API version **v2** events. Chargebee's **Test Webhook** button sends a sample of the event you pick, which should give a normal push.
12. Chargebee doesn't sign webhooks. It can send a username and password (basic authentication), but JustPush doesn't check them yet, so you can leave that off. Keep your endpoint URL private.

## Code

Studio calls `handleRequest(request)` with the incoming webhook (`{ method, headers, body, query, raw }`) and sends the message object it returns. Returning `null` sends nothing.

```js
// Chargebee → payment_failed
// Fires when an attempt to charge a customer fails, such as a declined card on a renewal.
// Docs: https://apidocs.chargebee.com/docs/api/events/webhook/payment_failed
//
// Paste this into a JustPush Studio integration and add a Chargebee webhook for the
// "payment_failed" event pointing at the integration's endpoint URL.
// Add ?site=your-site to the URL to get a button that opens the invoice in Chargebee.

// Chargebee amounts are whole numbers in the currency's smallest unit (2900 = €29.00),
// except for zero-decimal currencies such as JPY, where 500 means ¥500. This is Chargebee's
// own list: https://www.chargebee.com/docs/billing/2.0/site-configuration/supported-currencies
const ZERO_DECIMAL = new Set(["clp", "isk", "jpy", "krw", "mga", "pyg", "vnd", "xaf", "xof", "xpf"])

function money(amount, currency) {
    // Don't invent a figure when the event doesn't carry one.
    if (typeof amount !== "number" || !Number.isFinite(amount) || typeof currency !== "string" || !currency) return null

    const code = currency.toLowerCase()
    const value = ZERO_DECIMAL.has(code) ? amount : amount / 100

    try {
        return new Intl.NumberFormat("en-GB", { style: "currency", currency: code }).format(value)
    } catch {
        return `${value} ${code.toUpperCase()}`
    }
}

// A trimmed string, or null for anything else.
function text(value) {
    return typeof value === "string" && value.trim() ? value.trim() : null
}

// Only link to real http(s) URLs.
function link(url, cta) {
    return typeof url === "string" && /^https?:\/\//.test(url) ? [{ cta, url }] : []
}

// Chargebee events don't carry your site's name, so the dashboard link needs ?site=acme
// (or ?site=acme-test for a test site) on the webhook URL.
function adminUrl(request, path, id) {
    const raw = Array.isArray(request.query?.site) ? request.query.site[0] : request.query?.site
    const site = (typeof raw === "string" ? raw : "")
        .trim()
        .toLowerCase()
        .replace(/^https?:\/\//, "")
        .replace(/\.chargebee\.com.*$/, "")

    if (!/^[a-z0-9][a-z0-9-]*$/.test(site) || !text(id)) return null
    return `https://${site}.chargebee.com/d/${path}/${encodeURIComponent(id)}`
}

// "Jane Doe", or the company or email when there's no name.
function customerName(customer) {
    const name = [text(customer?.first_name), text(customer?.last_name)].filter(Boolean).join(" ")
    return name || text(customer?.company) || text(customer?.email)
}

// The plan's item price ID (Product Catalog 2.0) or plan ID (Product Catalog 1.0).
function planName(subscription) {
    if (!subscription || typeof subscription !== "object") return null
    const items = Array.isArray(subscription.subscription_items) ? subscription.subscription_items : []
    const item = items.find((entry) => entry?.item_type === "plan") ?? items[0]
    return text(item?.item_price_id) ?? text(subscription.plan_id)
}

// Chargebee timestamps are Unix seconds.
function day(seconds) {
    if (typeof seconds !== "number" || !Number.isFinite(seconds)) return null
    return new Date(seconds * 1000).toLocaleDateString("en-GB", {
        day: "numeric",
        month: "short",
        timeZone: "UTC",
    })
}

// The gateway's error message (or code), kept short enough for a notification.
function failure(transaction) {
    const raw = text(transaction.error_text) ?? text(transaction.error_code)?.replace(/_/g, " ")
    if (!raw) return null
    const clean = raw.replace(/\s+/g, " ").replace(/\.$/, "")
    return clean.length > 120 ? `${clean.slice(0, 119)}…` : clean
}

function handleRequest(request) {
    const event = request.body && typeof request.body === "object" ? request.body : {}

    // Guard: only this event type, so other Chargebee events on this integration stay quiet.
    // Chargebee sends no event header, so the payload's event_type decides.
    if (
        event.event_type !== "payment_failed" ||
        (event.object !== undefined && event.object !== "event") ||
        !event.content?.transaction ||
        typeof event.content.transaction !== "object"
    ) {
        console.log(`Ignoring Chargebee event "${text(event.event_type) ?? "unknown"}"`)
        return null
    }

    const { transaction, invoice, customer, subscription } = event.content
    const amount = money(transaction.amount, transaction.currency_code) ?? "A payment"
    const who = customerName(customer)
    const plan = planName(subscription)
    const reason = failure(transaction)
    const last4 = text(transaction.masked_card_number)?.match(/(\d{4})$/)?.[1]
    const card = last4 ? ` (card ••${last4})` : ""
    const retry = day(invoice?.next_retry_at)
    const invoiceUrl = adminUrl(request, "invoices", invoice?.id)

    return {
        title: "🚫 Payment failed",
        message:
            amount +
            (who ? ` from ${who}` : "") +
            (plan ? ` for ${plan}` : "") +
            (reason ? ` — ${reason}${card}` : card) +
            (retry ? `. Retrying ${retry}.` : ""),
        topic: "Chargebee",
        priority: 1, // High — a customer's payment didn't go through and revenue is at risk
        buttons: invoiceUrl
            ? link(invoiceUrl, "View invoice")
            : link(adminUrl(request, "customers", transaction.customer_id ?? customer?.id), "View customer"),
    }
}
```

## Chargebee payment_failed webhook payload (sample)

```json
{
  "id": "ev_test_payment_failed",
  "object": "event",
  "source": "scheduled_job",
  "content": {
    "invoice": {
      "id": "1043",
      "total": 2900,
      "object": "invoice",
      "status": "payment_due",
      "recurring": true,
      "amount_due": 2900,
      "amount_paid": 0,
      "customer_id": "cus_test_16BjpLU3",
      "currency_code": "EUR",
      "next_retry_at": 1790843400,
      "dunning_status": "in_progress",
      "subscription_id": "sub_test_16BjpLU3"
    },
    "customer": {
      "id": "cus_test_16BjpLU3",
      "email": "jane@example.com",
      "object": "customer",
      "last_name": "Doe",
      "first_name": "Jane"
    },
    "transaction": {
      "id": "txn_test_16BjpLU4",
      "date": 1790584200,
      "type": "payment",
      "amount": 2900,
      "object": "transaction",
      "status": "failure",
      "gateway": "stripe",
      "error_code": "card_declined",
      "error_text": "Your card has insufficient funds.",
      "customer_id": "cus_test_16BjpLU3",
      "currency_code": "EUR",
      "payment_method": "card",
      "subscription_id": "sub_test_16BjpLU3",
      "masked_card_number": "************4242"
    },
    "subscription": {
      "id": "sub_test_16BjpLU3",
      "object": "subscription",
      "status": "active",
      "currency_code": "EUR",
      "billing_period": 1,
      "subscription_items": [
        {
          "amount": 2900,
          "quantity": 1,
          "item_type": "plan",
          "unit_price": 2900,
          "item_price_id": "Pro-EUR-Monthly"
        }
      ],
      "billing_period_unit": "month"
    }
  },
  "event_type": "payment_failed",
  "api_version": "v2",
  "occurred_at": 1790584200,
  "webhook_status": "scheduled"
}
```

## FAQ

### Does this work on iPhone and Android?

Yes. Install the JustPush app from the App Store or Google Play and sign in. Every phone signed in to your account gets the notification.

### Do I need to write code?

No. Install the recipe in Studio, paste your webhook URL into Chargebee and you are done. The code is there if you want to change the text, the sound or the buttons.

### Can I change what the notification says?

Yes. After install the recipe's code is yours. Edit it in Studio and test it against the sample payload before you save.

### What does it cost?

JustPush is free for 30 days. After that it's $19.99 a year, or $39.99 once. There is no extra charge for recipes.