@metamask/subscription-controller 0.1.0

package/dist/types.d.mts

@@ -0,0 +1,211 @@
+import type { Hex } from "@metamask/utils";
+export declare const PRODUCT_TYPES: {
+    readonly SHIELD: "shield";
+};
+export type ProductType = (typeof PRODUCT_TYPES)[keyof typeof PRODUCT_TYPES];
+export declare const PAYMENT_TYPES: {
+    readonly byCard: "card";
+    readonly byCrypto: "crypto";
+};
+export type PaymentType = (typeof PAYMENT_TYPES)[keyof typeof PAYMENT_TYPES];
+export declare const RECURRING_INTERVALS: {
+    readonly month: "month";
+    readonly year: "year";
+};
+export type RecurringInterval = (typeof RECURRING_INTERVALS)[keyof typeof RECURRING_INTERVALS];
+export declare const SUBSCRIPTION_STATUSES: {
+    readonly incomplete: "incomplete";
+    readonly incompleteExpired: "incomplete_expired";
+    readonly provisional: "provisional";
+    readonly trialing: "trialing";
+    readonly active: "active";
+    readonly pastDue: "past_due";
+    readonly unpaid: "unpaid";
+    readonly canceled: "canceled";
+    readonly paused: "paused";
+};
+export type SubscriptionStatus = (typeof SUBSCRIPTION_STATUSES)[keyof typeof SUBSCRIPTION_STATUSES];
+/** only usd for now */
+export type Currency = 'usd';
+export type Product = {
+    name: ProductType;
+    currency: Currency;
+    unitAmount: number;
+    unitDecimals: number;
+};
+export type Subscription = {
+    id: string;
+    products: Product[];
+    currentPeriodStart: string;
+    currentPeriodEnd: string;
+    /** is subscription scheduled for cancellation */
+    cancelAtPeriodEnd?: boolean;
+    status: SubscriptionStatus;
+    interval: RecurringInterval;
+    paymentMethod: SubscriptionPaymentMethod;
+    trialPeriodDays?: number;
+    trialStart?: string;
+    trialEnd?: string;
+    /** is subscription ending soon */
+    endDate?: string;
+    billingCycles?: number;
+};
+export type SubscriptionCardPaymentMethod = {
+    type: Extract<PaymentType, 'card'>;
+    card: {
+        brand: string;
+        last4: string;
+    };
+};
+export type SubscriptionCryptoPaymentMethod = {
+    type: Extract<PaymentType, 'crypto'>;
+    crypto: {
+        payerAddress: Hex;
+        chainId: Hex;
+        tokenSymbol: string;
+    };
+};
+export type SubscriptionPaymentMethod = SubscriptionCardPaymentMethod | SubscriptionCryptoPaymentMethod;
+export type GetSubscriptionsResponse = {
+    customerId?: string;
+    subscriptions: Subscription[];
+    trialedProducts: ProductType[];
+};
+export type StartSubscriptionRequest = {
+    products: ProductType[];
+    isTrialRequested: boolean;
+    recurringInterval: RecurringInterval;
+};
+export type StartSubscriptionResponse = {
+    checkoutSessionUrl: string;
+};
+export type StartCryptoSubscriptionRequest = {
+    products: ProductType[];
+    isTrialRequested: boolean;
+    recurringInterval: RecurringInterval;
+    billingCycles: number;
+    chainId: Hex;
+    payerAddress: Hex;
+    /**
+     * e.g. "USDC"
+     */
+    tokenSymbol: string;
+    rawTransaction: Hex;
+};
+export type StartCryptoSubscriptionResponse = {
+    subscriptionId: string;
+    status: SubscriptionStatus;
+};
+export type AuthUtils = {
+    getAccessToken: () => Promise<string>;
+};
+export type ProductPrice = {
+    interval: RecurringInterval;
+    unitAmount: number;
+    unitDecimals: number;
+    /** only usd for now */
+    currency: Currency;
+    trialPeriodDays: number;
+    minBillingCycles: number;
+};
+export type ProductPricing = {
+    name: ProductType;
+    prices: ProductPrice[];
+};
+export type TokenPaymentInfo = {
+    symbol: string;
+    address: Hex;
+    decimals: number;
+    /**
+     * example: {
+        usd: '1.0',
+      },
+     */
+    conversionRate: {
+        usd: string;
+    };
+};
+export type ChainPaymentInfo = {
+    chainId: Hex;
+    paymentAddress: Hex;
+    tokens: TokenPaymentInfo[];
+};
+export type PricingPaymentMethod = {
+    type: PaymentType;
+    chains?: ChainPaymentInfo[];
+};
+export type PricingResponse = {
+    products: ProductPricing[];
+    paymentMethods: PricingPaymentMethod[];
+};
+export type GetCryptoApproveTransactionRequest = {
+    /**
+     * payment chain ID
+     */
+    chainId: Hex;
+    /**
+     * Payment token address
+     */
+    paymentTokenAddress: Hex;
+    productType: ProductType;
+    interval: RecurringInterval;
+};
+export type GetCryptoApproveTransactionResponse = {
+    /**
+     * The amount to approve
+     * e.g: "100000000"
+     */
+    approveAmount: string;
+    /**
+     * The contract address (spender)
+     */
+    paymentAddress: Hex;
+    /**
+     * The payment token address
+     */
+    paymentTokenAddress: Hex;
+    chainId: Hex;
+};
+export type ISubscriptionService = {
+    getSubscriptions(): Promise<GetSubscriptionsResponse>;
+    cancelSubscription(request: {
+        subscriptionId: string;
+    }): Promise<Subscription>;
+    unCancelSubscription(request: {
+        subscriptionId: string;
+    }): Promise<Subscription>;
+    startSubscriptionWithCard(request: StartSubscriptionRequest): Promise<StartSubscriptionResponse>;
+    getBillingPortalUrl(): Promise<BillingPortalResponse>;
+    getPricing(): Promise<PricingResponse>;
+    startSubscriptionWithCrypto(request: StartCryptoSubscriptionRequest): Promise<StartCryptoSubscriptionResponse>;
+    updatePaymentMethodCard(request: UpdatePaymentMethodCardRequest): Promise<void>;
+    updatePaymentMethodCrypto(request: UpdatePaymentMethodCryptoRequest): Promise<void>;
+};
+export type UpdatePaymentMethodOpts = ({
+    paymentType: Extract<PaymentType, 'card'>;
+} & UpdatePaymentMethodCardRequest) | ({
+    paymentType: Extract<PaymentType, 'crypto'>;
+} & UpdatePaymentMethodCryptoRequest);
+export type UpdatePaymentMethodCardRequest = {
+    /**
+     * Subscription ID
+     */
+    subscriptionId: string;
+    /**
+     * Recurring interval
+     */
+    recurringInterval: RecurringInterval;
+};
+export type UpdatePaymentMethodCryptoRequest = {
+    subscriptionId: string;
+    chainId: Hex;
+    payerAddress: Hex;
+    tokenSymbol: string;
+    rawTransaction: Hex;
+    recurringInterval: RecurringInterval;
+    billingCycles: number;
+};
+export type BillingPortalResponse = {
+    url: string;
+};
+//# sourceMappingURL=types.d.mts.map

package/dist/types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C,eAAO,MAAM,aAAa;;CAEhB,CAAC;AAEX,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAE7E,eAAO,MAAM,aAAa;;;CAGhB,CAAC;AAEX,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAE7E,eAAO,MAAM,mBAAmB;;;CAGtB,CAAC;AAEX,MAAM,MAAM,iBAAiB,GAC3B,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,OAAO,mBAAmB,CAAC,CAAC;AAEjE,eAAO,MAAM,qBAAqB;;;;;;;;;;CAexB,CAAC;AAEX,MAAM,MAAM,kBAAkB,GAC5B,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAC;AAErE,uBAAuB;AACvB,MAAM,MAAM,QAAQ,GAAG,KAAK,CAAC;AAE7B,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAGF,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,gBAAgB,EAAE,MAAM,CAAC;IACzB,iDAAiD;IACjD,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,MAAM,EAAE,kBAAkB,CAAC;IAC3B,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,aAAa,EAAE,yBAAyB,CAAC;IACzC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kCAAkC;IAClC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACnC,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IACrC,MAAM,EAAE;QACN,YAAY,EAAE,GAAG,CAAC;QAClB,OAAO,EAAE,GAAG,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,yBAAyB,GACjC,6BAA6B,GAC7B,+BAA+B,CAAC;AAEpC,MAAM,MAAM,wBAAwB,GAAG;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,eAAe,EAAE,WAAW,EAAE,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,iBAAiB,EAAE,iBAAiB,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,GAAG,CAAC;IACb,YAAY,EAAE,GAAG,CAAC;IAClB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,GAAG,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,kBAAkB,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,cAAc,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,uBAAuB;IACvB,QAAQ,EAAE,QAAQ,CAAC;IACnB,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,EAAE,YAAY,EAAE,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,GAAG,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,cAAc,EAAE;QACd,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,GAAG,CAAC;IACb,cAAc,EAAE,GAAG,CAAC;IACpB,MAAM,EAAE,gBAAgB,EAAE,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,cAAc,EAAE,oBAAoB,EAAE,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC;IACb;;OAEG;IACH,mBAAmB,EAAE,GAAG,CAAC;IACzB,WAAW,EAAE,WAAW,CAAC;IACzB,QAAQ,EAAE,iBAAiB,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,mCAAmC,GAAG;IAChD;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,cAAc,EAAE,GAAG,CAAC;IACpB;;OAEG;IACH,mBAAmB,EAAE,GAAG,CAAC;IACzB,OAAO,EAAE,GAAG,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,gBAAgB,IAAI,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACtD,kBAAkB,CAAC,OAAO,EAAE;QAC1B,cAAc,EAAE,MAAM,CAAC;KACxB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC1B,oBAAoB,CAAC,OAAO,EAAE;QAC5B,cAAc,EAAE,MAAM,CAAC;KACxB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC1B,yBAAyB,CACvB,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IACtC,mBAAmB,IAAI,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACtD,UAAU,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IACvC,2BAA2B,CACzB,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAC5C,uBAAuB,CACrB,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,yBAAyB,CACvB,OAAO,EAAE,gCAAgC,GACxC,OAAO,CAAC,IAAI,CAAC,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAC/B,CAAC;IACC,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;CAC3C,GAAG,8BAA8B,CAAC,GACnC,CAAC;IACC,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;CAC7C,GAAG,gCAAgC,CAAC,CAAC;AAE1C,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,iBAAiB,EAAE,iBAAiB,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,GAAG,CAAC;IACb,YAAY,EAAE,GAAG,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,GAAG,CAAC;IACpB,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,GAAG,EAAE,MAAM,CAAC;CACb,CAAC"}

package/dist/types.mjs

@@ -0,0 +1,28 @@
+export const PRODUCT_TYPES = {
+    SHIELD: 'shield',
+};
+export const PAYMENT_TYPES = {
+    byCard: 'card',
+    byCrypto: 'crypto',
+};
+export const RECURRING_INTERVALS = {
+    month: 'month',
+    year: 'year',
+};
+export const SUBSCRIPTION_STATUSES = {
+    // Initial states
+    incomplete: 'incomplete',
+    incompleteExpired: 'incomplete_expired',
+    // Active states
+    provisional: 'provisional',
+    trialing: 'trialing',
+    active: 'active',
+    // Payment issues
+    pastDue: 'past_due',
+    unpaid: 'unpaid',
+    // Cancelled states
+    canceled: 'canceled',
+    // Paused states
+    paused: 'paused',
+};
+//# sourceMappingURL=types.mjs.map

package/dist/types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,MAAM,EAAE,QAAQ;CACR,CAAC;AAIX,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,MAAM,EAAE,MAAM;IACd,QAAQ,EAAE,QAAQ;CACV,CAAC;AAIX,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;CACJ,CAAC;AAKX,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,iBAAiB;IACjB,UAAU,EAAE,YAAY;IACxB,iBAAiB,EAAE,oBAAoB;IACvC,gBAAgB;IAChB,WAAW,EAAE,aAAa;IAC1B,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;IAChB,iBAAiB;IACjB,OAAO,EAAE,UAAU;IACnB,MAAM,EAAE,QAAQ;IAChB,mBAAmB;IACnB,QAAQ,EAAE,UAAU;IACpB,gBAAgB;IAChB,MAAM,EAAE,QAAQ;CACR,CAAC","sourcesContent":["import type { Hex } from '@metamask/utils';\n\nexport const PRODUCT_TYPES = {\n  SHIELD: 'shield',\n} as const;\n\nexport type ProductType = (typeof PRODUCT_TYPES)[keyof typeof PRODUCT_TYPES];\n\nexport const PAYMENT_TYPES = {\n  byCard: 'card',\n  byCrypto: 'crypto',\n} as const;\n\nexport type PaymentType = (typeof PAYMENT_TYPES)[keyof typeof PAYMENT_TYPES];\n\nexport const RECURRING_INTERVALS = {\n  month: 'month',\n  year: 'year',\n} as const;\n\nexport type RecurringInterval =\n  (typeof RECURRING_INTERVALS)[keyof typeof RECURRING_INTERVALS];\n\nexport const SUBSCRIPTION_STATUSES = {\n  // Initial states\n  incomplete: 'incomplete',\n  incompleteExpired: 'incomplete_expired',\n  // Active states\n  provisional: 'provisional',\n  trialing: 'trialing',\n  active: 'active',\n  // Payment issues\n  pastDue: 'past_due',\n  unpaid: 'unpaid',\n  // Cancelled states\n  canceled: 'canceled',\n  // Paused states\n  paused: 'paused',\n} as const;\n\nexport type SubscriptionStatus =\n  (typeof SUBSCRIPTION_STATUSES)[keyof typeof SUBSCRIPTION_STATUSES];\n\n/** only usd for now */\nexport type Currency = 'usd';\n\nexport type Product = {\n  name: ProductType;\n  currency: Currency;\n  unitAmount: number;\n  unitDecimals: number;\n};\n\n// state\nexport type Subscription = {\n  id: string;\n  products: Product[];\n  currentPeriodStart: string; // ISO 8601\n  currentPeriodEnd: string; // ISO 8601\n  /** is subscription scheduled for cancellation */\n  cancelAtPeriodEnd?: boolean;\n  status: SubscriptionStatus;\n  interval: RecurringInterval;\n  paymentMethod: SubscriptionPaymentMethod;\n  trialPeriodDays?: number;\n  trialStart?: string; // ISO 8601\n  trialEnd?: string; // ISO 8601\n  /** is subscription ending soon */\n  endDate?: string; // ISO 8601\n  billingCycles?: number;\n};\n\nexport type SubscriptionCardPaymentMethod = {\n  type: Extract<PaymentType, 'card'>;\n  card: {\n    brand: string;\n    last4: string;\n  };\n};\n\nexport type SubscriptionCryptoPaymentMethod = {\n  type: Extract<PaymentType, 'crypto'>;\n  crypto: {\n    payerAddress: Hex;\n    chainId: Hex;\n    tokenSymbol: string;\n  };\n};\n\nexport type SubscriptionPaymentMethod =\n  | SubscriptionCardPaymentMethod\n  | SubscriptionCryptoPaymentMethod;\n\nexport type GetSubscriptionsResponse = {\n  customerId?: string;\n  subscriptions: Subscription[];\n  trialedProducts: ProductType[];\n};\n\nexport type StartSubscriptionRequest = {\n  products: ProductType[];\n  isTrialRequested: boolean;\n  recurringInterval: RecurringInterval;\n};\n\nexport type StartSubscriptionResponse = {\n  checkoutSessionUrl: string;\n};\n\nexport type StartCryptoSubscriptionRequest = {\n  products: ProductType[];\n  isTrialRequested: boolean;\n  recurringInterval: RecurringInterval;\n  billingCycles: number;\n  chainId: Hex;\n  payerAddress: Hex;\n  /**\n   * e.g. \"USDC\"\n   */\n  tokenSymbol: string;\n  rawTransaction: Hex;\n};\n\nexport type StartCryptoSubscriptionResponse = {\n  subscriptionId: string;\n  status: SubscriptionStatus;\n};\n\nexport type AuthUtils = {\n  getAccessToken: () => Promise<string>;\n};\n\nexport type ProductPrice = {\n  interval: RecurringInterval;\n  unitAmount: number; // amount in the smallest unit of the currency, e.g., cents\n  unitDecimals: number; // number of decimals for the smallest unit of the currency\n  /** only usd for now */\n  currency: Currency;\n  trialPeriodDays: number;\n  minBillingCycles: number;\n};\n\nexport type ProductPricing = {\n  name: ProductType;\n  prices: ProductPrice[];\n};\n\nexport type TokenPaymentInfo = {\n  symbol: string;\n  address: Hex;\n  decimals: number;\n  /**\n   * example: {\n      usd: '1.0',\n    },\n   */\n  conversionRate: {\n    usd: string;\n  };\n};\n\nexport type ChainPaymentInfo = {\n  chainId: Hex;\n  paymentAddress: Hex;\n  tokens: TokenPaymentInfo[];\n};\n\nexport type PricingPaymentMethod = {\n  type: PaymentType;\n  chains?: ChainPaymentInfo[];\n};\n\nexport type PricingResponse = {\n  products: ProductPricing[];\n  paymentMethods: PricingPaymentMethod[];\n};\n\nexport type GetCryptoApproveTransactionRequest = {\n  /**\n   * payment chain ID\n   */\n  chainId: Hex;\n  /**\n   * Payment token address\n   */\n  paymentTokenAddress: Hex;\n  productType: ProductType;\n  interval: RecurringInterval;\n};\n\nexport type GetCryptoApproveTransactionResponse = {\n  /**\n   * The amount to approve\n   * e.g: \"100000000\"\n   */\n  approveAmount: string;\n  /**\n   * The contract address (spender)\n   */\n  paymentAddress: Hex;\n  /**\n   * The payment token address\n   */\n  paymentTokenAddress: Hex;\n  chainId: Hex;\n};\n\nexport type ISubscriptionService = {\n  getSubscriptions(): Promise<GetSubscriptionsResponse>;\n  cancelSubscription(request: {\n    subscriptionId: string;\n  }): Promise<Subscription>;\n  unCancelSubscription(request: {\n    subscriptionId: string;\n  }): Promise<Subscription>;\n  startSubscriptionWithCard(\n    request: StartSubscriptionRequest,\n  ): Promise<StartSubscriptionResponse>;\n  getBillingPortalUrl(): Promise<BillingPortalResponse>;\n  getPricing(): Promise<PricingResponse>;\n  startSubscriptionWithCrypto(\n    request: StartCryptoSubscriptionRequest,\n  ): Promise<StartCryptoSubscriptionResponse>;\n  updatePaymentMethodCard(\n    request: UpdatePaymentMethodCardRequest,\n  ): Promise<void>;\n  updatePaymentMethodCrypto(\n    request: UpdatePaymentMethodCryptoRequest,\n  ): Promise<void>;\n};\n\nexport type UpdatePaymentMethodOpts =\n  | ({\n      paymentType: Extract<PaymentType, 'card'>;\n    } & UpdatePaymentMethodCardRequest)\n  | ({\n      paymentType: Extract<PaymentType, 'crypto'>;\n    } & UpdatePaymentMethodCryptoRequest);\n\nexport type UpdatePaymentMethodCardRequest = {\n  /**\n   * Subscription ID\n   */\n  subscriptionId: string;\n\n  /**\n   * Recurring interval\n   */\n  recurringInterval: RecurringInterval;\n};\n\nexport type UpdatePaymentMethodCryptoRequest = {\n  subscriptionId: string;\n  chainId: Hex;\n  payerAddress: Hex;\n  tokenSymbol: string;\n  rawTransaction: Hex;\n  recurringInterval: RecurringInterval;\n  billingCycles: number;\n};\n\nexport type BillingPortalResponse = {\n  url: string;\n};\n"]}

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@metamask/subscription-controller",
+  "version": "0.1.0",
+  "description": "Handle user subscription",
+  "keywords": [
+    "MetaMask",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/core/tree/main/packages/subscription-controller#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/core/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/core.git"
+  },
+  "license": "MIT",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.cts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
+    "build:docs": "typedoc",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/subscription-controller",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/subscription-controller",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
+    "publish:preview": "yarn npm publish --tag preview",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
+    "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
+    "test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
+    "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
+  },
+  "dependencies": {
+    "@metamask/base-controller": "^8.3.0",
+    "@metamask/controller-utils": "^11.14.0",
+    "@metamask/utils": "^11.8.0"
+  },
+  "devDependencies": {
+    "@metamask/auto-changelog": "^3.4.4",
+    "@metamask/profile-sync-controller": "^25.0.0",
+    "@types/jest": "^27.4.1",
+    "deepmerge": "^4.2.2",
+    "jest": "^27.5.1",
+    "ts-jest": "^27.1.4",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-missing-exports": "^2.0.0",
+    "typescript": "~5.2.2"
+  },
+  "peerDependencies": {
+    "@metamask/profile-sync-controller": "^25.0.0"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}