# Chargebee new subscription notifications on your phone

> Get a push notification when a customer starts a Chargebee subscription, with the plan, price and any trial.

- Company: Chargebee (https://www.justpush.io/recipes/chargebee)
- Event: `subscription_created` (subscription_created)
- Tags: Payments & billing, Subscriptions
- Install: https://studio.justpush.io/recipes/chargebee/subscription-created
- Web page: https://www.justpush.io/recipes/chargebee/subscription-created

## 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 subscription_created and save the webhook.
5. Under **Events to Send**, pick only `subscription_created` (Chargebee selects All Events by default). Subscriptions created with a backdated start send `subscription_created_with_backdating` instead, which this recipe ignores.
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 subscription 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 → subscription_created
// Fires when a new subscription is created, including ones that start in trial or at a future date.
// Docs: https://apidocs.chargebee.com/docs/api/events/webhook/subscription_created
//
// Paste this into a JustPush Studio integration and add a Chargebee webhook for the
// "subscription_created" event pointing at the integration's endpoint URL.
// Add ?site=your-site to the URL to get a button that opens the subscription 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)
}

// 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",
    })
}

// Describe the plan, e.g. "Pro-EUR-Monthly — €29.00/month".
// Product Catalog 2.0 lists subscription_items; Product Catalog 1.0 uses plan_id and plan_amount.
function plan(subscription) {
    const items = Array.isArray(subscription.subscription_items) ? subscription.subscription_items : []
    const item = items.find((entry) => entry?.item_type === "plan") ?? items[0]
    const name = text(item?.item_price_id) ?? text(subscription.plan_id)

    if (!name) return null

    const quantity = item ? item.quantity ?? 1 : subscription.plan_quantity ?? 1
    const unit = item ? item.unit_price : subscription.plan_unit_price
    const total = item ? item.amount : subscription.plan_amount
    const amount = typeof total === "number" ? total : typeof unit === "number" ? unit * quantity : null
    const price = money(amount, subscription.currency_code)

    const period = subscription.billing_period
    const unitName = text(subscription.billing_period_unit)
    const every = !unitName ? "" : period > 1 ? ` every ${period} ${unitName}s` : `/${unitName}`
    const more = items.length > 1 ? ` + ${items.length - 1} more` : ""

    return name + (price ? ` — ${price}${every}` : "") + more
}

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 !== "subscription_created" ||
        (event.object !== undefined && event.object !== "event") ||
        !event.content?.subscription ||
        typeof event.content.subscription !== "object"
    ) {
        console.log(`Ignoring Chargebee event "${text(event.event_type) ?? "unknown"}"`)
        return null
    }

    const subscription = event.content.subscription
    const who = customerName(event.content.customer) ?? "Someone"
    const what = plan(subscription)
    const trialEnds = day(subscription.trial_end)
    const startsOn = day(subscription.start_date)
    const when =
        subscription.status === "in_trial" && trialEnds
            ? ` (trial until ${trialEnds})`
            : subscription.status === "future" && startsOn
              ? ` (starts ${startsOn})`
              : ""

    return {
        title: "🎉 New subscription",
        message: (what ? `${who} subscribed to ${what}` : `${who} started a subscription`) + when,
        topic: "Chargebee",
        priority: 0, // Normal — recurring revenue, worth a smile
        sound: "cashregister",
        buttons: link(adminUrl(request, "subscriptions", subscription.id), "View subscription"),
    }
}
```

## Chargebee subscription_created webhook payload (sample)

```json
{
  "id": "ev_test_subscription_created",
  "object": "event",
  "source": "hosted_page",
  "content": {
    "customer": {
      "id": "cus_test_16BjpLU3",
      "email": "jane@example.com",
      "object": "customer",
      "last_name": "Doe",
      "first_name": "Jane"
    },
    "subscription": {
      "id": "sub_test_16BjpLU3",
      "object": "subscription",
      "status": "in_trial",
      "trial_end": 1791793800,
      "created_at": 1790584200,
      "customer_id": "cus_test_16BjpLU3",
      "trial_start": 1790584200,
      "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": "subscription_created",
  "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.
