@shopify/shopify-api/lib/billing/update-usage-subscription-capped-amount.ts

Shopify API Library for Node - accelerate development with support for authentication, graphql proxy, webhooks

import {BillingError, GraphqlQueryError} from '../error';
import {ConfigInterface} from '../base-types';
import {graphqlClientClass} from '../clients/admin';

import {
  BillingUpdateUsageCappedAmount,
  BillingUpdateUsageCappedAmountParams,
  BillingUpdateUsageCappedAmountResponse,
  UpdateCappedAmountConfirmation,
  APP_SUBSCRIPTION_FRAGMENT,
} from './types';
import {convertLineItems} from './utils';

const UPDATE_USAGE_CAPPED_AMOUNT_MUTATION = `
${APP_SUBSCRIPTION_FRAGMENT}
mutation appSubscriptionLineItemUpdate($cappedAmount: MoneyInput!, $id: ID!) {
  appSubscriptionLineItemUpdate(cappedAmount: $cappedAmount, id: $id) {
    userErrors {
      field
      message
    }
    confirmationUrl
    appSubscription {
      ...AppSubscriptionFragment
    }
  }
}
`;

export function updateUsageCappedAmount(
  config: ConfigInterface,
): BillingUpdateUsageCappedAmount {
  return async function updateUsageCappedAmount(
    params: BillingUpdateUsageCappedAmountParams,
  ): Promise<UpdateCappedAmountConfirmation> {
    if (!config.billing) {
      throw new BillingError({
        message: 'Attempted to update line item without billing configs',
        errorData: [],
      });
    }

    const {
      session,
      subscriptionLineItemId,
      cappedAmount: {amount, currencyCode},
    } = params;

    const GraphqlClient = graphqlClientClass({config});
    const client = new GraphqlClient({session});

    try {
      const response =
        await client.request<BillingUpdateUsageCappedAmountResponse>(
          UPDATE_USAGE_CAPPED_AMOUNT_MUTATION,
          {
            variables: {
              id: subscriptionLineItemId,
              cappedAmount: {
                amount,
                currencyCode,
              },
            },
          },
        );

      if (response.data?.appSubscriptionLineItemUpdate?.userErrors.length) {
        throw new BillingError({
          message: 'Error while updating usage subscription capped amount',
          errorData: response.data?.appSubscriptionLineItemUpdate?.userErrors,
        });
      }

      const appSubscription =
        response.data?.appSubscriptionLineItemUpdate?.appSubscription!;
      if (appSubscription && appSubscription.lineItems) {
        appSubscription.lineItems = convertLineItems(appSubscription.lineItems);
      }

      return {
        confirmationUrl:
          response.data?.appSubscriptionLineItemUpdate?.confirmationUrl!,
        appSubscription,
      };
    } catch (error) {
      if (error instanceof GraphqlQueryError) {
        throw new BillingError({
          message: error.message,
          errorData: error.response?.errors,
        });
      }

      throw error;
    }
  };
}