@shopify/shopify-app-remix 1.0.0-rc.0

package/build/ts/billing/index.d.ts

@@ -0,0 +1,4 @@
+export { cancelBillingFactory } from './cancel';
+export { requireBillingFactory } from './require';
+export { requestBillingFactory } from './request';
+//# sourceMappingURL=index.d.ts.map

package/build/ts/billing/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/billing/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,oBAAoB,EAAC,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAC,qBAAqB,EAAC,MAAM,WAAW,CAAC;AAChD,OAAO,EAAC,qBAAqB,EAAC,MAAM,WAAW,CAAC"}

package/build/ts/billing/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requestBillingFactory = exports.requireBillingFactory = exports.cancelBillingFactory = void 0;
+var cancel_1 = require("./cancel");
+Object.defineProperty(exports, "cancelBillingFactory", { enumerable: true, get: function () { return cancel_1.cancelBillingFactory; } });
+var require_1 = require("./require");
+Object.defineProperty(exports, "requireBillingFactory", { enumerable: true, get: function () { return require_1.requireBillingFactory; } });
+var request_1 = require("./request");
+Object.defineProperty(exports, "requestBillingFactory", { enumerable: true, get: function () { return request_1.requestBillingFactory; } });
+//# sourceMappingURL=index.js.map

package/build/ts/billing/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/billing/index.ts"],"names":[],"mappings":";;;AAAA,mCAA8C;AAAtC,8GAAA,oBAAoB,OAAA;AAC5B,qCAAgD;AAAxC,gHAAA,qBAAqB,OAAA;AAC7B,qCAAgD;AAAxC,gHAAA,qBAAqB,OAAA"}

package/build/ts/billing/request.d.ts

@@ -0,0 +1,6 @@
+import { Session } from '@shopify/shopify-api';
+import type { BasicParams } from '../types';
+import { AppConfigArg } from '../config-types';
+import type { RequestBillingOptions } from './types';
+export declare function requestBillingFactory<Config extends AppConfigArg>(params: BasicParams, request: Request, session: Session): ({ plan, isTest, returnUrl, }: RequestBillingOptions<Config>) => Promise<never>;
+//# sourceMappingURL=request.d.ts.map

package/build/ts/billing/request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../../src/billing/request.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,OAAO,EACR,MAAM,sBAAsB,CAAC;AAG9B,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,UAAU,CAAC;AAE1C,OAAO,EAAC,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAG7C,OAAO,KAAK,EAAC,qBAAqB,EAAC,MAAM,SAAS,CAAC;AAEnD,wBAAgB,qBAAqB,CAAC,MAAM,SAAS,YAAY,EAC/D,MAAM,EAAE,WAAW,EACnB,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,OAAO,kCAMb,sBAAsB,MAAM,CAAC,KAAG,QAAQ,KAAK,CAAC,CAqClD"}

package/build/ts/billing/request.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requestBillingFactory = void 0;
+var tslib_1 = require("tslib");
+var shopify_api_1 = require("@shopify/shopify-api");
+var server_runtime_1 = require("@remix-run/server-runtime");
+var helpers_1 = require("../auth/helpers");
+var redirect_with_app_bridge_headers_1 = require("../auth/helpers/redirect-with-app-bridge-headers");
+function requestBillingFactory(params, request, session) {
+    return function requestBilling(_a) {
+        var plan = _a.plan, isTest = _a.isTest, returnUrl = _a.returnUrl;
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var api, logger, result, error_1;
+            return tslib_1.__generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        api = params.api, logger = params.logger;
+                        logger.info('Requesting billing', {
+                            shop: session.shop,
+                            plan: plan,
+                            isTest: isTest,
+                            returnUrl: returnUrl,
+                        });
+                        _b.label = 1;
+                    case 1:
+                        _b.trys.push([1, 3, , 7]);
+                        return [4 /*yield*/, api.billing.request({
+                                plan: plan,
+                                session: session,
+                                isTest: isTest,
+                                returnUrl: returnUrl,
+                                returnObject: true,
+                            })];
+                    case 2:
+                        result = _b.sent();
+                        return [3 /*break*/, 7];
+                    case 3:
+                        error_1 = _b.sent();
+                        if (!(error_1 instanceof shopify_api_1.HttpResponseError && error_1.response.code === 401)) return [3 /*break*/, 5];
+                        logger.debug('API token was invalid, redirecting to OAuth', {
+                            shop: session.shop,
+                        });
+                        return [4 /*yield*/, (0, helpers_1.redirectToAuthPage)(params, request, session.shop)];
+                    case 4: throw _b.sent();
+                    case 5: throw error_1;
+                    case 6: return [3 /*break*/, 7];
+                    case 7: throw redirectOutOfApp(params, request, result.confirmationUrl, session.shop);
+                }
+            });
+        });
+    };
+}
+exports.requestBillingFactory = requestBillingFactory;
+function redirectOutOfApp(params, request, url, shop) {
+    var config = params.config, logger = params.logger;
+    logger.debug('Redirecting out of app', { url: url });
+    var requestUrl = new URL(request.url);
+    var isEmbeddedRequest = requestUrl.searchParams.get('embedded') === '1';
+    var isXhrRequest = request.headers.get('authorization');
+    if (isXhrRequest) {
+        // eslint-disable-next-line no-warning-comments
+        // TODO Check this with the beta flag disabled (with the bounce page)
+        // Remix is not including the X-Shopify-API-Request-Failure-Reauthorize-Url when throwing a Response
+        // https://github.com/remix-run/remix/issues/5356
+        throw new Response(undefined, {
+            status: 401,
+            statusText: 'Unauthorized',
+            headers: (0, redirect_with_app_bridge_headers_1.getAppBridgeHeaders)(params, url, shop),
+        });
+    }
+    else if (isEmbeddedRequest) {
+        var params_1 = new URLSearchParams({
+            shop: shop,
+            host: requestUrl.searchParams.get('host'),
+            exitIframe: url,
+        });
+        throw (0, server_runtime_1.redirect)("".concat(config.auth.exitIframePath, "?").concat(params_1.toString()));
+    }
+    else {
+        // This will only ever happen for non-embedded apps, because the authenticator will stop before reaching this point
+        throw (0, server_runtime_1.redirect)(url);
+    }
+}
+//# sourceMappingURL=request.js.map

package/build/ts/billing/request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.js","sourceRoot":"","sources":["../../../src/billing/request.ts"],"names":[],"mappings":";;;;AAAA,oDAI8B;AAC9B,4DAAmD;AAGnD,2CAAmD;AAEnD,qGAAqF;AAIrF,SAAgB,qBAAqB,CACnC,MAAmB,EACnB,OAAgB,EAChB,OAAgB;IAEhB,OAAO,SAAe,cAAc,CAAC,EAIL;YAH9B,IAAI,UAAA,EACJ,MAAM,YAAA,EACN,SAAS,eAAA;;;;;;wBAEF,GAAG,GAAY,MAAM,IAAlB,EAAE,MAAM,GAAI,MAAM,OAAV,CAAW;wBAE7B,MAAM,CAAC,IAAI,CAAC,oBAAoB,EAAE;4BAChC,IAAI,EAAE,OAAO,CAAC,IAAI;4BAClB,IAAI,MAAA;4BACJ,MAAM,QAAA;4BACN,SAAS,WAAA;yBACV,CAAC,CAAC;;;;wBAIQ,qBAAM,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC;gCACjC,IAAI,EAAE,IAAc;gCACpB,OAAO,SAAA;gCACP,MAAM,QAAA;gCACN,SAAS,WAAA;gCACT,YAAY,EAAE,IAAI;6BACnB,CAAC,EAAA;;wBANF,MAAM,GAAG,SAMP,CAAC;;;;6BAEC,CAAA,OAAK,YAAY,+BAAiB,IAAI,OAAK,CAAC,QAAQ,CAAC,IAAI,KAAK,GAAG,CAAA,EAAjE,wBAAiE;wBACnE,MAAM,CAAC,KAAK,CAAC,6CAA6C,EAAE;4BAC1D,IAAI,EAAE,OAAO,CAAC,IAAI;yBACnB,CAAC,CAAC;wBACG,qBAAM,IAAA,4BAAkB,EAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,EAAA;4BAA7D,MAAM,SAAuD,CAAC;4BAE9D,MAAM,OAAK,CAAC;;4BAIhB,MAAM,gBAAgB,CACpB,MAAM,EACN,OAAO,EACP,MAAM,CAAC,eAAe,EACtB,OAAO,CAAC,IAAI,CACb,CAAC;;;;KACH,CAAC;AACJ,CAAC;AA9CD,sDA8CC;AAED,SAAS,gBAAgB,CACvB,MAAmB,EACnB,OAAgB,EAChB,GAAW,EACX,IAAY;IAEL,IAAA,MAAM,GAAY,MAAM,OAAlB,EAAE,MAAM,GAAI,MAAM,OAAV,CAAW;IAEhC,MAAM,CAAC,KAAK,CAAC,wBAAwB,EAAE,EAAC,GAAG,KAAA,EAAC,CAAC,CAAC;IAE9C,IAAM,UAAU,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACxC,IAAM,iBAAiB,GAAG,UAAU,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,GAAG,CAAC;IAC1E,IAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IAE1D,IAAI,YAAY,EAAE;QAChB,+CAA+C;QAC/C,qEAAqE;QACrE,oGAAoG;QACpG,iDAAiD;QACjD,MAAM,IAAI,QAAQ,CAAC,SAAS,EAAE;YAC5B,MAAM,EAAE,GAAG;YACX,UAAU,EAAE,cAAc;YAC1B,OAAO,EAAE,IAAA,sDAAmB,EAAC,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC;SAChD,CAAC,CAAC;KACJ;SAAM,IAAI,iBAAiB,EAAE;QAC5B,IAAM,QAAM,GAAG,IAAI,eAAe,CAAC;YACjC,IAAI,MAAA;YACJ,IAAI,EAAE,UAAU,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAE;YAC1C,UAAU,EAAE,GAAG;SAChB,CAAC,CAAC;QAEH,MAAM,IAAA,yBAAQ,EAAC,UAAG,MAAM,CAAC,IAAI,CAAC,cAAc,cAAI,QAAM,CAAC,QAAQ,EAAE,CAAE,CAAC,CAAC;KACtE;SAAM;QACL,mHAAmH;QACnH,MAAM,IAAA,yBAAQ,EAAC,GAAG,CAAC,CAAC;KACrB;AACH,CAAC"}

package/build/ts/billing/require.d.ts

@@ -0,0 +1,6 @@
+import { BillingCheckResponseObject, Session } from '@shopify/shopify-api';
+import type { BasicParams } from '../types';
+import type { AppConfigArg } from '../config-types';
+import type { RequireBillingOptions } from './types';
+export declare function requireBillingFactory<Config extends AppConfigArg>(params: BasicParams, request: Request, session: Session): (options: RequireBillingOptions<Config>) => Promise<BillingCheckResponseObject>;
+//# sourceMappingURL=require.d.ts.map

package/build/ts/billing/require.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"require.d.ts","sourceRoot":"","sources":["../../../src/billing/require.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,0BAA0B,EAE1B,OAAO,EACR,MAAM,sBAAsB,CAAC;AAE9B,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,UAAU,CAAC;AAC1C,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAGlD,OAAO,KAAK,EAAC,qBAAqB,EAAC,MAAM,SAAS,CAAC;AAEnD,wBAAgB,qBAAqB,CAAC,MAAM,SAAS,YAAY,EAC/D,MAAM,EAAE,WAAW,EACnB,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,OAAO,aAI8B,sBAAsB,MAAM,CAAC,yCAmC5E"}

package/build/ts/billing/require.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requireBillingFactory = void 0;
+var tslib_1 = require("tslib");
+var shopify_api_1 = require("@shopify/shopify-api");
+var helpers_1 = require("../auth/helpers");
+function requireBillingFactory(params, request, session) {
+    var api = params.api, logger = params.logger;
+    return function requireBilling(options) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var logContext, data, error_1;
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        logContext = {
+                            shop: session.shop,
+                            plans: options.plans,
+                            isTest: options.isTest,
+                        };
+                        logger.debug('Checking billing for the shop', logContext);
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 7]);
+                        return [4 /*yield*/, api.billing.check({
+                                session: session,
+                                plans: options.plans,
+                                isTest: options.isTest,
+                                returnObject: true,
+                            })];
+                    case 2:
+                        data = _a.sent();
+                        return [3 /*break*/, 7];
+                    case 3:
+                        error_1 = _a.sent();
+                        if (!(error_1 instanceof shopify_api_1.HttpResponseError && error_1.response.code === 401)) return [3 /*break*/, 5];
+                        logger.debug('API token was invalid, redirecting to OAuth', logContext);
+                        return [4 /*yield*/, (0, helpers_1.redirectToAuthPage)(params, request, session.shop)];
+                    case 4: throw _a.sent();
+                    case 5: throw error_1;
+                    case 6: return [3 /*break*/, 7];
+                    case 7:
+                        if (!!data.hasActivePayment) return [3 /*break*/, 9];
+                        logger.debug('Billing check failed', logContext);
+                        return [4 /*yield*/, options.onFailure(new Error('Billing check failed'))];
+                    case 8: throw _a.sent();
+                    case 9:
+                        logger.debug('Billing check succeeded', logContext);
+                        return [2 /*return*/, data];
+                }
+            });
+        });
+    };
+}
+exports.requireBillingFactory = requireBillingFactory;
+//# sourceMappingURL=require.js.map

package/build/ts/billing/require.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"require.js","sourceRoot":"","sources":["../../../src/billing/require.ts"],"names":[],"mappings":";;;;AAAA,oDAI8B;AAI9B,2CAAmD;AAInD,SAAgB,qBAAqB,CACnC,MAAmB,EACnB,OAAgB,EAChB,OAAgB;IAET,IAAA,GAAG,GAAY,MAAM,IAAlB,EAAE,MAAM,GAAI,MAAM,OAAV,CAAW;IAE7B,OAAO,SAAe,cAAc,CAAC,OAAsC;;;;;;wBACnE,UAAU,GAAG;4BACjB,IAAI,EAAE,OAAO,CAAC,IAAI;4BAClB,KAAK,EAAE,OAAO,CAAC,KAAK;4BACpB,MAAM,EAAE,OAAO,CAAC,MAAM;yBACvB,CAAC;wBAEF,MAAM,CAAC,KAAK,CAAC,+BAA+B,EAAE,UAAU,CAAC,CAAC;;;;wBAIjD,qBAAM,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC;gCAC7B,OAAO,SAAA;gCACP,KAAK,EAAE,OAAO,CAAC,KAAiB;gCAChC,MAAM,EAAE,OAAO,CAAC,MAAM;gCACtB,YAAY,EAAE,IAAI;6BACnB,CAAC,EAAA;;wBALF,IAAI,GAAG,SAKL,CAAC;;;;6BAEC,CAAA,OAAK,YAAY,+BAAiB,IAAI,OAAK,CAAC,QAAQ,CAAC,IAAI,KAAK,GAAG,CAAA,EAAjE,wBAAiE;wBACnE,MAAM,CAAC,KAAK,CAAC,6CAA6C,EAAE,UAAU,CAAC,CAAC;wBAClE,qBAAM,IAAA,4BAAkB,EAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,EAAA;4BAA7D,MAAM,SAAuD,CAAC;4BAE9D,MAAM,OAAK,CAAC;;;6BAIZ,CAAC,IAAI,CAAC,gBAAgB,EAAtB,wBAAsB;wBACxB,MAAM,CAAC,KAAK,CAAC,sBAAsB,EAAE,UAAU,CAAC,CAAC;wBAC3C,qBAAM,OAAO,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC,EAAA;4BAAhE,MAAM,SAA0D,CAAC;;wBAGnE,MAAM,CAAC,KAAK,CAAC,yBAAyB,EAAE,UAAU,CAAC,CAAC;wBAEpD,sBAAO,IAAI,EAAC;;;;KACb,CAAC;AACJ,CAAC;AA1CD,sDA0CC"}

package/build/ts/billing/types.d.ts

@@ -0,0 +1,228 @@
+import { AppSubscription, BillingCheckParams, BillingCheckResponseObject, BillingRequestParams } from '@shopify/shopify-api';
+import type { AppConfigArg } from '../config-types';
+export interface RequireBillingOptions<Config extends AppConfigArg> extends Omit<BillingCheckParams, 'session' | 'plans' | 'returnObject'> {
+    /**
+     * The plans to check for. Must be one of the values defined in the `billing` config option.
+     */
+    plans: (keyof Config['billing'])[];
+    /**
+     * How to handle the request if the shop does not have an active payment for any of the given plans.
+     */
+    onFailure: (error: any) => Promise<Response>;
+}
+export interface RequestBillingOptions<Config extends AppConfigArg> extends Omit<BillingRequestParams, 'session' | 'plan' | 'returnObject'> {
+    /**
+     * The plan to request. Must be one of the values defined in the `billing` config option.
+     */
+    plan: keyof Config['billing'];
+}
+export interface CancelBillingOptions {
+    /**
+     * The ID of the subscription to cancel.
+     */
+    subscriptionId: string;
+    /**
+     * Whether to prorate the cancellation.
+     *
+     * {@link https://shopify.dev/docs/apps/billing/subscriptions/cancel-recurring-charges}
+     */
+    prorate?: boolean;
+    isTest?: boolean;
+}
+export interface BillingContext<Config extends AppConfigArg> {
+    /**
+     * Checks if the shop has an active payment for any the given plans defined in the `billing` config option.
+     *
+     * @returns A promise that resolves to an object containing the active purchases for the shop.
+     *
+     * @example
+     * Requesting billing right away
+     * ```ts
+     * // shopify.server.ts
+     * import { shopifyApp, BillingInterval } from "@shopify/shopify-app-remix";
+     *
+     * export const MONTHLY_PLAN = 'Monthly subscription';
+     * export const ANNUAL_PLAN = 'Annual subscription';
+     *
+     * export const shopify = shopifyApp({
+     *   // ...etc
+     *   billing: {
+     *     [MONTHLY_PLAN]: {
+     *       amount: 5,
+     *       currencyCode: 'USD',
+     *       interval: BillingInterval.Every30Days,
+     *     },
+     *     [ANNUAL_PLAN]: {
+     *       amount: 50,
+     *       currencyCode: 'USD',
+     *       interval: BillingInterval.Annual,
+     *     },
+     *   }
+     * });
+     *
+     * // app/routes/**\/.ts
+     * import { LoaderArgs } from "@remix-run/node";
+     * import { shopify, MONTHLY_PLAN } from "../shopify.server";
+     *
+     * export const loader = async ({ request }: LoaderArgs) => {
+     *   const { billing } = await shopify.authenticate.admin(request);
+     *   await billing.require({
+     *     plans: [MONTHLY_PLAN],
+     *     isTest: true,
+     *     onFailure: async () => billing.request({ plan: MONTHLY_PLAN }),
+     *   });
+     *
+     *   // App logic
+     * };
+     * ```
+     *
+     * @example
+     * Redirecting to a page where the merchant can select a plan
+     * ```ts
+     * // shopify.server.ts
+     * import { shopifyApp, BillingInterval } from "@shopify/shopify-app-remix";
+     *
+     * export const MONTHLY_PLAN = 'Monthly subscription';
+     * export const ANNUAL_PLAN = 'Annual subscription';
+     *
+     * export const shopify = shopifyApp({
+     *   // ...etc
+     *   billing: {
+     *     [MONTHLY_PLAN]: {
+     *       amount: 5,
+     *       currencyCode: 'USD',
+     *       interval: BillingInterval.Every30Days,
+     *     },
+     *     [ANNUAL_PLAN]: {
+     *       amount: 50,
+     *       currencyCode: 'USD',
+     *       interval: BillingInterval.Annual,
+     *     },
+     *   }
+     * });
+     *
+     * // app/routes/**\/.ts
+     * import { LoaderArgs, redirect } from "@remix-run/node";
+     * import { shopify, MONTHLY_PLAN, ANNUAL_PLAN } from "../shopify.server";
+     *
+     * export const loader = async ({ request }: LoaderArgs) => {
+     *   const { billing } = await shopify.authenticate.admin(request);
+     *   const billingCheck = await billing.require({
+     *     plans: [MONTHLY_PLAN, ANNUAL_PLAN],
+     *     isTest: true,
+     *     onFailure: () => redirect('/select-plan'),
+     *   });
+     *
+     *   const subscription = billingCheck.appSubscriptions[0];
+     *   console.log(`Shop is on ${subscription.name} (id ${subscription.id})`);
+     *
+     *   // App logic
+     * };
+     * ```
+     */
+    require: (options: RequireBillingOptions<Config>) => Promise<BillingCheckResponseObject>;
+    /**
+     * Requests payment for the given plan.
+     *
+     * @returns Redirects to the confirmation URL for the payment.
+     *
+     * @example
+     * Requesting billing when there is no payment with a custom return URL
+     * ```ts
+     * // shopify.server.ts
+     * import { shopifyApp, BillingInterval } from "@shopify/shopify-app-remix";
+     *
+     * export const MONTHLY_PLAN = 'Monthly subscription';
+     * export const ANNUAL_PLAN = 'Annual subscription';
+     *
+     * export const shopify = shopifyApp({
+     *   // ...etc
+     *   billing: {
+     *     [MONTHLY_PLAN]: {
+     *       amount: 5,
+     *       currencyCode: 'USD',
+     *       interval: BillingInterval.Every30Days,
+     *     },
+     *     [ANNUAL_PLAN]: {
+     *       amount: 50,
+     *       currencyCode: 'USD',
+     *       interval: BillingInterval.Annual,
+     *     },
+     *   }
+     * });
+     *
+     * // app/routes/**\/.ts
+     * import { LoaderArgs } from "@remix-run/node";
+     * import { shopify, MONTHLY_PLAN } from "../shopify.server";
+     *
+     * export const loader = async ({ request }: LoaderArgs) => {
+     *   const { billing } = await shopify.authenticate.admin(request);
+     *   await billing.require({
+     *     plans: [MONTHLY_PLAN],
+     *     onFailure: async () => billing.request({
+     *       plan: MONTHLY_PLAN,
+     *       isTest: true,
+     *       returnUrl: '/billing-complete',
+     *     }),
+     *   });
+     *
+     *   // App logic
+     * };
+     * ```
+     */
+    request: (options: RequestBillingOptions<Config>) => Promise<never>;
+    /**
+     * Cancels an ongoing subscription, given its id.
+     *
+     * @returns The cancelled subscription.
+     *
+     * @example
+     * Cancelling a subscription
+     * ```ts
+     * // shopify.server.ts
+     * import { shopifyApp, BillingInterval } from "@shopify/shopify-app-remix";
+     *
+     * export const MONTHLY_PLAN = 'Monthly subscription';
+     * export const ANNUAL_PLAN = 'Annual subscription';
+     *
+     * export const shopify = shopifyApp({
+     *   // ...etc
+     *   billing: {
+     *     [MONTHLY_PLAN]: {
+     *       amount: 5,
+     *       currencyCode: 'USD',
+     *       interval: BillingInterval.Every30Days,
+     *     },
+     *     [ANNUAL_PLAN]: {
+     *       amount: 50,
+     *       currencyCode: 'USD',
+     *       interval: BillingInterval.Annual,
+     *     },
+     *   }
+     * });
+     *
+     * // app/routes/cancel-subscription.ts
+     * import { LoaderArgs } from "@remix-run/node";
+     * import { shopify, MONTHLY_PLAN } from "../shopify.server";
+     *
+     * export const loader = async ({ request }: LoaderArgs) => {
+     *   const { billing } = await shopify.authenticate.admin(request);
+     *   const billingCheck = await billing.require({
+     *     plans: [MONTHLY_PLAN],
+     *     onFailure: async () => billing.request({ plan: MONTHLY_PLAN }),
+     *   });
+     *
+     *   const subscription = billingCheck.appSubscriptions[0];
+     *   const cancelledSubscription = await billing.cancel({
+     *     subscriptionId: subscription.id,
+     *     isTest: true,
+     *     prorate: true,
+     *    });
+     *
+     *   // App logic
+     * };
+     * ```
+     */
+    cancel: (options: CancelBillingOptions) => Promise<AppSubscription>;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/ts/billing/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/billing/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,kBAAkB,EAClB,0BAA0B,EAC1B,oBAAoB,EACrB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAElD,MAAM,WAAW,qBAAqB,CAAC,MAAM,SAAS,YAAY,CAChE,SAAQ,IAAI,CAAC,kBAAkB,EAAE,SAAS,GAAG,OAAO,GAAG,cAAc,CAAC;IACtE;;OAEG;IACH,KAAK,EAAE,CAAC,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;IACnC;;OAEG;IACH,SAAS,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;CAC9C;AAED,MAAM,WAAW,qBAAqB,CAAC,MAAM,SAAS,YAAY,CAChE,SAAQ,IAAI,CAAC,oBAAoB,EAAE,SAAS,GAAG,MAAM,GAAG,cAAc,CAAC;IACvE;;OAEG;IACH,IAAI,EAAE,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,cAAc,CAAC,MAAM,SAAS,YAAY;IACzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyFG;IACH,OAAO,EAAE,CACP,OAAO,EAAE,qBAAqB,CAAC,MAAM,CAAC,KACnC,OAAO,CAAC,0BAA0B,CAAC,CAAC;IAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,OAAO,EAAE,CAAC,OAAO,EAAE,qBAAqB,CAAC,MAAM,CAAC,KAAK,OAAO,CAAC,KAAK,CAAC,CAAC;IAEpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmDG;IACH,MAAM,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,OAAO,CAAC,eAAe,CAAC,CAAC;CACrE"}

package/build/ts/billing/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/build/ts/billing/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/billing/types.ts"],"names":[],"mappings":""}