-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #55 from gadget-inc/usage-updates
Updating usage app charges to use a new flow
- Loading branch information
Showing
4 changed files
with
222 additions
and
217 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,160 @@ | ||
| import { ActionOptions, ChargeShopGlobalActionContext } from "gadget-server"; | ||
| import { getCappedAmount } from "../../utilities"; | ||
|
|
||
| /** | ||
| * @param { ChargeShopGlobalActionContext } context | ||
| */ | ||
| export async function run({ params, logger, api, connections }) { | ||
| const { shop, order } = params; | ||
|
|
||
| // Creating an instance of the Shopify Admin API | ||
| const shopify = await connections.shopify.forShopId(shop.id); | ||
|
|
||
| // Returning early if the shop is uninstalled and no Shopify instance is created | ||
| if (!shopify) | ||
| return logger.warn({ | ||
| message: "BILLING - Shop uninstalled", | ||
| shopId: shop.id, | ||
| }); | ||
|
|
||
| // Fetching the amount used in the period | ||
| const { amountUsedInPeriod } = await api.shopifyShop.findOne(shop.id, { | ||
| amountUsedInPeriod: true, | ||
| }); | ||
|
|
||
| let remainder = 0; | ||
|
|
||
| // Fetching the subscription at the time | ||
| const subscription = await api.shopifyAppSubscription.maybeFindOne( | ||
| shop?.activeSubscriptionId, | ||
| { | ||
| select: { | ||
| lineItems: true, | ||
| }, | ||
| } | ||
| ); | ||
|
|
||
| if (!subscription) | ||
| return logger.warn({ | ||
| message: "BILLING - No subscription found for the shop", | ||
| shopId: shop.id, | ||
| }); | ||
|
|
||
| // Pulling out the capped amount from the active subscription | ||
| const cappedAmount = getCappedAmount(subscription); | ||
|
|
||
| if (!cappedAmount) | ||
| return logger.warn({ | ||
| message: "BILLING - No capped amount found for the shop", | ||
| shopId: shop.id, | ||
| }); | ||
|
|
||
| // Initially setting the price to the plan price and adding the overage amount if they exist | ||
| let price = shop.plan?.price + (shop.overage || 0) || 0; | ||
|
|
||
| // Returning early if the amount used in the period is greater than or equal to the capped amount | ||
| if (amountUsedInPeriod >= cappedAmount) { | ||
| // Modifying the overage amount of the current shop | ||
| return await api.internal.shopifyShop.update(shop.id, { | ||
| overage: price, | ||
| }); | ||
| } | ||
|
|
||
| // Calculating the available amount | ||
| const availableAmount = cappedAmount - amountUsedInPeriod; | ||
|
|
||
| // Setting a remainder if the price is greater than the available amount | ||
| if (price >= availableAmount) { | ||
| remainder = price - availableAmount; | ||
| price = availableAmount; | ||
| } | ||
|
|
||
| // Creating the usage charge with the Shopify Billing API | ||
| const result = await shopify.graphql( | ||
| `mutation ($description: String!, $price: MoneyInput!, $subscriptionLineItemId: ID!) { | ||
| appUsageRecordCreate(description: $description, price: $price, subscriptionLineItemId: $subscriptionLineItemId) { | ||
| appUsageRecord { | ||
| id | ||
| } | ||
| userErrors { | ||
| field | ||
| message | ||
| } | ||
| } | ||
| }`, | ||
| { | ||
| description: shop.overage | ||
| ? `Charge of ${price} ${shop.currency} ${ | ||
| order.email ? `for order placed by ${order.email}` : "" | ||
| }, with overages from the previous billing period` | ||
| : `Charge of ${price} ${shop.currency} for order placed by ${order.email}`, | ||
| price: { | ||
| amount: price, | ||
| currencyCode: shop.currency, | ||
| }, | ||
| subscriptionLineItemId: shop.usagePlanId, | ||
| } | ||
| ); | ||
|
|
||
| // Throwing an error if the charge fails | ||
| if (result?.appUsageRecordCreate?.userErrors?.length) | ||
| throw new Error(result.appUsageRecordCreate.userErrors[0].message); | ||
|
|
||
| // Creating the usage charge record in the database | ||
| await api.internal.usageRecord.create({ | ||
| id: result.appUsageRecordCreate.appUsageRecord.id.split("/")[4], | ||
| price, | ||
| currency: shop.currency, | ||
| shop: { | ||
| _link: shop.id, | ||
| }, | ||
| }); | ||
|
|
||
| // Updating the overage amount if there is a remainder | ||
| if (remainder) | ||
| await api.internal.shopifyShop.update(shop.id, { | ||
| overage: remainder, | ||
| }); | ||
| } | ||
|
|
||
| /** @type { ActionOptions } */ | ||
| export const options = {}; | ||
|
|
||
| export const params = { | ||
| shop: { | ||
| type: "object", | ||
| properties: { | ||
| id: { | ||
| type: "string", | ||
| }, | ||
| activeSubscriptionId: { | ||
| type: "string", | ||
| }, | ||
| usagePlanId: { | ||
| type: "string", | ||
| }, | ||
| currency: { | ||
| type: "string", | ||
| }, | ||
| overage: { | ||
| type: "number", | ||
| }, | ||
| plan: { | ||
| type: "object", | ||
| properties: { | ||
| price: { | ||
| type: "number", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| order: { | ||
| type: "object", | ||
| properties: { | ||
| email: { | ||
| type: "string", | ||
| }, | ||
| }, | ||
| }, | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.