mirror of
https://github.com/fleetdm/fleet
synced 2026-05-17 05:58:40 +00:00
ceec0e4cdd
Changes: - updated the stripe webhook to support `invoice.paid` events when a subscription's host count is not increased.
294 lines
17 KiB
JavaScript
Vendored
294 lines
17 KiB
JavaScript
Vendored
module.exports = {
|
||
|
||
|
||
friendlyName: 'Receive Stripe subscription events',
|
||
|
||
|
||
description: 'Receive events from Stripe about subscription renewals',
|
||
|
||
|
||
inputs: {
|
||
id: {
|
||
type: 'string',
|
||
description: 'The unique identifier for this Stripe event.',
|
||
moreInfoUrl: 'https://stripe.com/docs/api/events/object#event_object-id',
|
||
required: true,
|
||
},
|
||
type: {
|
||
type: 'string',
|
||
description: 'The type of this Stripe event.',
|
||
moreInfoUrl: 'https://stripe.com/docs/api/events/object#event_object-type',
|
||
required: true,
|
||
},
|
||
data: {
|
||
type: {object: {}},
|
||
description: 'An object containing data associated with this Stripe event.',
|
||
moreInfoUrl: 'https://stripe.com/docs/api/events/object#event_object-data',
|
||
required: true,
|
||
},
|
||
webhookSecret: {
|
||
type: 'string',
|
||
description: 'Used to verify that requests are coming from Stripe.',
|
||
required: true,
|
||
},
|
||
},
|
||
|
||
|
||
exits: {
|
||
success: { description: 'A Stripe event has successfully been received' },
|
||
missingStripeHeader: { description: 'The webhook received a request with no stripe-signature header', responseType: 'unauthorized'},
|
||
},
|
||
|
||
|
||
fn: async function ({id, type, data, webhookSecret}) {
|
||
const stripe = require('stripe')(sails.config.custom.stripeSecret);
|
||
let assert = require('assert');
|
||
|
||
if(!this.req.get('stripe-signature')) {
|
||
throw 'missingStripeHeader';
|
||
}
|
||
|
||
if (!sails.config.custom.stripeSubscriptionWebhookSecret) {
|
||
throw new Error('No Stripe webhook secret configured! (Please set `sails.config.custom.stripeSubscriptionWebhookSecret`.)');
|
||
}
|
||
|
||
if (sails.config.custom.stripeSubscriptionWebhookSecret !== webhookSecret) {
|
||
throw new Error('Received unexpected Stripe webhook request with webhookSecret set to: '+webhookSecret);
|
||
}
|
||
|
||
let stripeEventData = data.object;
|
||
|
||
// If this event does not include a subscription ID, we'll ignore it and return a 200 response.
|
||
if(!stripeEventData.subscription) {
|
||
return;
|
||
}
|
||
assert(stripeEventData.customer !== undefined);
|
||
|
||
// Find the subscription record for this event.
|
||
let subscriptionIdToFind = stripeEventData.subscription;
|
||
let subscriptionForThisEvent = await Subscription.findOne({stripeSubscriptionId: subscriptionIdToFind}).populate('user');
|
||
|
||
let STRIPE_EVENTS_SENT_BEFORE_A_SUBSCRIPTION_RECORD_EXISTS = [
|
||
'invoice.created',// Sent when a user submits the billing form on /customers/new-license, before the user's biliing card is charged.
|
||
'invoice.finalized',// Sent when a user submits the billing form on /customers/new-license, before the user's biliing card is charged.
|
||
'invoice.paid',//Sent when a user submits the billing form on /customers/new-license, when the user's biliing card is charged.
|
||
'invoice.payment_succeeded',// Sent when payment for a users subscription is successful. The save-billing-info-and-subscribe action will check for this event before creating a license key.
|
||
'invoice.payment_failed',// Sent when a users subscritpion payment fails. This can happen before we create a license key and save the subscription in the database.
|
||
'invoice.payment_action_required',// Sent when a user's billing card requires additional verification from stripe.
|
||
'invoice.updated',// Sent before an incomplete invoice is voided. (~24 hours after a payment fails)
|
||
'invoice.voided',// Sent when an incomplete invoice is marked as voided. (~24 hours after a payment fails)
|
||
'checkout.session.completed'// Sent when a user completes a Stripe Checkout session.
|
||
];
|
||
|
||
// If this event is for a subscription that was just created, we won't have a matching Subscription record in the database. This is because we wait until the subscription's invoice is paid to create the record in our database.
|
||
// To handle cases like this, we'll check to see if a User with the provided stripe customer ID exists, and throw an error if it does not exist.
|
||
if(!subscriptionForThisEvent) {
|
||
if(!_.contains(STRIPE_EVENTS_SENT_BEFORE_A_SUBSCRIPTION_RECORD_EXISTS, type)) {
|
||
throw new Error(`The Stripe subscription events webhook received a event for a subscription with stripeSubscriptionId: ${subscriptionIdToFind}, but no matching record was found in our database.`);
|
||
} else {
|
||
let userReferencedInStripeEvent = await User.findOne({stripeCustomerId: stripeEventData.customer});
|
||
if(!userReferencedInStripeEvent) {
|
||
throw new Error(`The receive-from-stripe webhook received an event for an invoice (type: ${type}) for a subscription (stripeSubscriptionId: ${subscriptionIdToFind}) but no matching Subscription or User record (stripeCustomerId: ${stripeEventData.customer}) was found in our databse.`);
|
||
}
|
||
}
|
||
}
|
||
|
||
let userForThisSubscription = await User.findOne({stripeCustomerId: stripeEventData.customer});
|
||
if(!userForThisSubscription){
|
||
throw new Error(`The stripe subscription events webhook received a type ${type} event for a user with stripeCustomerId: ${stripeEventData.customer}, but no matching user was found in the databse. Stripe event ID: ${id}`);
|
||
}
|
||
// ┬ ┬┌─┐┌─┐┌─┐┌┬┐┬┌┐┌┌─┐ ┬─┐┌─┐┌┐┌┌─┐┬ ┬┌─┐┬
|
||
// │ │├─┘│ │ │││││││││ ┬ ├┬┘├┤ │││├┤ │││├─┤│
|
||
// └─┘┴ └─┘└─┘┴ ┴┴┘└┘└─┘ ┴└─└─┘┘└┘└─┘└┴┘┴ ┴┴─┘
|
||
// If stripe thinks this subscription renews in 7 days, we'll send the user an subscription reminder email.
|
||
if(type === 'invoice.upcoming' && stripeEventData.billing_reason === 'upcoming') {
|
||
// Get the subscription cost per host for the Subscription renewal notification email.
|
||
let subscriptionCostPerHost = (subscriptionForThisEvent.subscriptionPrice / subscriptionForThisEvent.numberOfHosts / 12).toFixed(2);
|
||
let upcomingBillingAt = stripeEventData.next_payment_attempt * 1000;
|
||
// Send a upcoming subscription renewal email.
|
||
await sails.helpers.sendTemplateEmail.with({
|
||
to: userForThisSubscription.emailAddress,
|
||
from: sails.config.custom.fromEmailAddress,
|
||
fromName: sails.config.custom.fromName,
|
||
subject: 'Your Fleet Premium subscription',
|
||
template: 'email-upcoming-subscription-renewal',
|
||
templateData: {
|
||
firstName: userForThisSubscription.firstName,
|
||
lastName: userForThisSubscription.lastName,
|
||
subscriptionPriceInWholeDollars: subscriptionForThisEvent.subscriptionPrice,
|
||
numberOfHosts: subscriptionForThisEvent.numberOfHosts,
|
||
subscriptionCostPerHost: subscriptionCostPerHost,
|
||
nextBillingAt: upcomingBillingAt,
|
||
}
|
||
});
|
||
// ┌─┐┬ ┬┌┐ ┌─┐┌─┐┬─┐┬┌─┐┌┬┐┬┌─┐┌┐┌ ┬─┐┌─┐┌┐┌┌─┐┬ ┬┌─┐┌┬┐
|
||
// └─┐│ │├┴┐└─┐│ ├┬┘│├─┘ │ ││ ││││ ├┬┘├┤ │││├┤ │││├┤ ││
|
||
// └─┘└─┘└─┘└─┘└─┘┴└─┴┴ ┴ ┴└─┘┘└┘ ┴└─└─┘┘└┘└─┘└┴┘└─┘─┴┘
|
||
} else if(type === 'invoice.paid' && stripeEventData.billing_reason === 'subscription_cycle') {
|
||
// If the event was triggered by a user's card successfully being charged by Stripe, we'll generate a new license key, update the subscription's database record, and send the user a renewal confirmation email.
|
||
|
||
if(!stripeEventData.lines || !stripeEventData.lines.data[0]) {
|
||
throw new Error(`When the Stripe subscription events webhook received an event for a paid invoice for subscription id: ${subscriptionIdToFind}, the event data object is missing information about the paid invoice. Check the Stripe dashboard to see the data for this event (Stripe event id: ${id})`);
|
||
}
|
||
|
||
// Get the information about the paid invoice from the stripe event.
|
||
let paidInvoiceInformation = stripeEventData.lines.data[0];
|
||
|
||
// Convert the new subscription cycle's period end timestamp from Stripe into a JS timestamp.
|
||
let nextBillingAt = paidInvoiceInformation.period.end * 1000;
|
||
|
||
// Generate a new license key for this subscription
|
||
let newLicenseKeyForThisSubscription = await sails.helpers.createLicenseKey.with({
|
||
numberOfHosts: subscriptionForThisEvent.numberOfHosts,
|
||
organization: subscriptionForThisEvent.user.organization,
|
||
expiresAt: nextBillingAt,
|
||
});
|
||
|
||
// Update the subscription record
|
||
await Subscription.updateOne({id: subscriptionForThisEvent.id}).set({
|
||
fleetLicenseKey: newLicenseKeyForThisSubscription,
|
||
nextBillingAt: nextBillingAt
|
||
});
|
||
|
||
// Send subscription renewal email
|
||
await sails.helpers.sendTemplateEmail.with({
|
||
to: userForThisSubscription.emailAddress,
|
||
from: sails.config.custom.fromEmailAddress,
|
||
fromName: sails.config.custom.fromName,
|
||
subject: 'Your Fleet Premium subscription',
|
||
template: 'email-subscription-renewal-confirmation',
|
||
templateData: {
|
||
firstName: userForThisSubscription.firstName,
|
||
lastName: userForThisSubscription.lastName,
|
||
}
|
||
});
|
||
// ┬┌┐┌┬ ┬┌─┐┬┌─┐┌─┐ ┌─┐┌─┐┬─┐ ┬ ┬┌─┐┌┬┐┌─┐┌┬┐┌─┐┌┬┐ ┌─┐┬ ┬┌┐ ┌─┐┌─┐┬─┐┬┌┬┐┌─┐┌┐┌ ┌─┐┌─┐┬┌┬┐
|
||
// ││││└┐┌┘│ │││ ├┤ ├┤ │ │├┬┘ │ │├─┘ ││├─┤ │ ├┤ ││ └─┐│ │├┴┐└─┐│ ├┬┘│ │ │ ││││ ├─┘├─┤│ ││
|
||
// ┴┘└┘ └┘ └─┘┴└─┘└─┘ └ └─┘┴└─ └─┘┴ ─┴┘┴ ┴ ┴ └─┘─┴┘ └─┘└─┘└─┘└─┘└─┘┴└─┴ ┴ └─┘┘└┘ ┴ ┴ ┴┴─┴┘
|
||
} else if (type === 'invoice.paid' && stripeEventData.billing_reason === 'subscription_update') {
|
||
// If the event was triggered by a customer paying an invoice that was sent to them after their subscription was updated, we'll generate a new license key with their updated informaton.
|
||
|
||
// Get the information about the paid invoice from the stripe event.
|
||
let itemsOnThisInvoice = stripeEventData.lines.data;
|
||
|
||
// Find the line item in the new invoice that contains the new information about this subscription.
|
||
let updatedSubscriptionInfo = _.find(itemsOnThisInvoice, (item)=>{
|
||
// Invoices for updated subscriptions list the new number of hosts with the remaining subscription period
|
||
// e.g., 'Remaining time on 9 × Fleet premium hosts after 17 Feb 2024'
|
||
return _.startsWith(item.description, 'Remaining');
|
||
});
|
||
// If this no line item that starts with "Remaining" was found, select the first line item on the invoice.
|
||
if(!updatedSubscriptionInfo){
|
||
updatedSubscriptionInfo = itemsOnThisInvoice[0];
|
||
}
|
||
// Convert the subscription cycle's period end timestamp from Stripe into a JS timestamp.
|
||
// Note: with most subscription changes, this value will be indentical to the existing license key's expiration
|
||
// timestamp. We do this here to handle situations where the subscription period has been adjusted in the Stripe UI.
|
||
let nextBillingAt = updatedSubscriptionInfo.period.end * 1000;
|
||
|
||
// Use information from the nested plan object to determine the new price of this subscription.
|
||
let pricePerHost = updatedSubscriptionInfo.plan.amount / 100;
|
||
|
||
// Get the updated number of hosts from the quantity of the invoice.
|
||
let newNumberOfHosts = updatedSubscriptionInfo.quantity;
|
||
|
||
let subscriptionPrice = Math.floor(pricePerHost * newNumberOfHosts);
|
||
|
||
// (Optionally) adjust the price of this subscription if a coupon was applied.
|
||
if(stripeEventData.discount){
|
||
if(stripeEventData.discount.coupon){
|
||
if(stripeEventData.discount.coupon.amount_off){
|
||
// If the coupon applied takes a fixed dollar amount off of the total price, subtact the amoutn fro mthe subscriptionPrice
|
||
subscriptionPrice = _.round(subscriptionPrice - (stripeEventData.discount.coupon.amount_off / 100), 2); // Note: coupon.amount_off contains the discounted amount in cents.
|
||
} else if(stripeEventData.discount.coupon.percent_off){
|
||
// Otherwise if it is a percent discount,
|
||
let discountAmount = subscriptionPrice * (stripeEventData.discount.coupon.percent_off / 100);
|
||
subscriptionPrice = _.round(subscriptionPrice - discountAmount, 2);
|
||
}
|
||
}
|
||
}
|
||
// Generate a new license key for this subscription
|
||
let newLicenseKeyForThisSubscription = await sails.helpers.createLicenseKey.with({
|
||
numberOfHosts: newNumberOfHosts,
|
||
organization: subscriptionForThisEvent.user.organization,
|
||
expiresAt: nextBillingAt,
|
||
});
|
||
|
||
// Update the subscription record
|
||
await Subscription.updateOne({id: subscriptionForThisEvent.id}).set({
|
||
numberOfHosts: newNumberOfHosts,
|
||
subscriptionPrice,
|
||
fleetLicenseKey: newLicenseKeyForThisSubscription,
|
||
nextBillingAt: nextBillingAt
|
||
});
|
||
} else if(type === 'checkout.session.completed' && stripeEventData.payment_status === 'paid') {
|
||
// For handling successful payments from a Stripe checkout session.
|
||
// Note: This event is sent the moment the user's payment succeeds.
|
||
if(subscriptionForThisEvent){// Throw an error if there is an existing subscription with this ID that matches this event in the website's database.
|
||
throw new Error(`Consistency violation! The stripe webhook received a "${type}" event for a new subscription being created, but a subscription with the stripe ID ${subscriptionForThisEvent.stripeSubscriptionId} already exists.`);
|
||
}
|
||
// Retrieve the subscription details from Stripe.
|
||
let newSubscriptionDetails = await stripe.subscriptions.retrieve(stripeEventData.subscription);
|
||
// Convert the timestamp of the next time this subscription will be billed into a JS timestamp (Epoch MS)
|
||
let nextBillingAt = newSubscriptionDetails.current_period_end * 1000;
|
||
// Get the number of Hosts.
|
||
let numberOfHosts = newSubscriptionDetails.quantity;
|
||
// Get the whole dollar price per host by subtracting the discount amount from the plan amount.
|
||
// [?]: https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-total_details
|
||
let subscriptionPricePerHost = newSubscriptionDetails.plan.amount / 100;
|
||
// Determine the annual cost of this user's subscription
|
||
let subscriptionPrice = (subscriptionPricePerHost * numberOfHosts) - (stripeEventData.total_details.amount_discount / 100);
|
||
// Generate a new license key.
|
||
let newLicenseKey = await sails.helpers.createLicenseKey.with({
|
||
numberOfHosts,
|
||
organization: userForThisSubscription.organization ? userForThisSubscription.organization : 'Unknown',
|
||
expiresAt: nextBillingAt,
|
||
});
|
||
// Create the database record for this subscription.
|
||
await Subscription.create({
|
||
nextBillingAt,
|
||
numberOfHosts,
|
||
subscriptionPrice,
|
||
stripeSubscriptionId: newSubscriptionDetails.id,
|
||
fleetLicenseKey: newLicenseKey,
|
||
user: userForThisSubscription.id,
|
||
});
|
||
|
||
await sails.helpers.sendTemplateEmail.with({
|
||
to: userForThisSubscription.emailAddress,
|
||
from: sails.config.custom.fromEmail,
|
||
fromName: sails.config.custom.fromName,
|
||
subject: 'Your Fleet Premium order',
|
||
template: 'email-order-confirmation',
|
||
templateData: {
|
||
firstName: userForThisSubscription.firstName ? userForThisSubscription.firstName : '',
|
||
lastName: userForThisSubscription.lastName ? userForThisSubscription.lastName : '',
|
||
}
|
||
});
|
||
|
||
let todayOn = new Date();
|
||
let isoTimestampForDescription = todayOn.toISOString();
|
||
sails.helpers.salesforce.updateOrCreateContactAndAccount.with({
|
||
emailAddress: userForThisSubscription.emailAddress,
|
||
firstName: userForThisSubscription.firstName,
|
||
lastName: userForThisSubscription.lastName,
|
||
organization: userForThisSubscription.organization,
|
||
contactSource: 'Website - Sign up',// Note: this is only set on new contacts.
|
||
description: `Purchased a self-service Fleet Premium license on ${isoTimestampForDescription.split('T')[0]} for ${numberOfHosts} host${numberOfHosts > 1 ? 's' : ''}.`
|
||
}).exec((err)=>{
|
||
if(err){
|
||
sails.log.warn(`Background task failed: When a user (email: ${userForThisSubscription.emailAddress} purchased a self-service Fleet premium subscription, a Contact and Account record could not be created/updated in the CRM.`, err);
|
||
}
|
||
return;
|
||
});
|
||
|
||
}
|
||
// FUTURE: send emails about failed payments. (type === 'invoice.payment_failed' && stripeEventData.billing_reason === 'subscription_cycle')
|
||
|
||
|
||
return;
|
||
|
||
}
|
||
|
||
|
||
};
|