@wtfalch/payments 0.1.0 → 0.2.0

package/dist/stripe.js

@@ -160,6 +160,13 @@ export function createStripeProvider(options) {
             };
         },
         async createRecurringAgreement(input) {
+            // Vipps-only: a SetupIntent has no pricing type or cap to declare up
+            // front -- it only saves a payment method, and the amount for each
+            // later charge is decided at `chargeRecurringAgreement` time. See the
+            // `variablePricing` doc comment on `CreateRecurringAgreementInput`.
+            if (input.variablePricing) {
+                throw new PaymentProviderError('stripe', 'variablePricing is not supported: a Stripe SetupIntent has no pricing type or cap to declare up front');
+            }
             const si = await call('/setup_intents', {
                 usage: 'off_session',
                 'metadata[reference]': input.reference,

package/dist/types.d.ts

@@ -64,7 +64,10 @@ export interface CreateRecurringAgreementInput {
     readonly reference: string;
     /** The periodic charge amount. Stripe's SetupIntent does not itself need
      * one, but it is required here for symmetry with Vipps and because a
-     * caller building the agreement already knows it. */
+     * caller building the agreement already knows it. Under `variablePricing`,
+     * Vipps ignores this for the agreement itself (there is no fixed price to
+     * declare); it is still required, as an estimate for Stripe's metadata and
+     * for a caller that has not yet decided the actual per-charge amounts. */
     readonly amount: Money;
     readonly productName: string;
     /** Where the payer returns after approving the agreement. */
@@ -76,6 +79,21 @@ export interface CreateRecurringAgreementInput {
         readonly unit: 'day' | 'week' | 'month';
         readonly count: number;
     };
+    /** Vipps Recurring `pricing.type: 'VARIABLE'`: the agreement has no fixed
+     * price, only a `suggestedMaxAmount` shown to the payer when they approve
+     * it (the payer may accept a different max, and can change it later).
+     * Each `chargeRecurringAgreement` call then charges its own amount --
+     * e.g. a plan fee plus that month's metered usage -- as long as it is at
+     * or below the max the payer accepted; a charge above it is held `DUE`
+     * and fails if the payer has not raised their max by `due` + `retryDays`.
+     * Omit for the existing fixed-price ("LEGACY") behaviour, unchanged.
+     * Vipps-only: `createStripeProvider` throws `PaymentProviderError` if this
+     * is given, since a Stripe SetupIntent has no pricing type or cap to
+     * declare up front. Same currency as `amount`.
+     * https://developer.vippsmobilepay.com/api/recurring/ */
+    readonly variablePricing?: {
+        readonly suggestedMaxAmount: number;
+    };
     readonly idempotencyKey?: string;
 }
 export interface RecurringAgreementResult {

package/dist/vipps.js

@@ -187,12 +187,21 @@ export function createVippsProvider(options) {
             };
         },
         async createRecurringAgreement(input) {
-            const agreement = await post('/recurring/v3/agreements', {
-                pricing: {
+            // pricing.type LEGACY (fixed amount) vs VARIABLE (suggestedMaxAmount,
+            // no fixed amount): https://developer.vippsmobilepay.com/api/recurring/
+            const pricing = input.variablePricing
+                ? {
+                    type: 'VARIABLE',
+                    currency: input.amount.currency.toUpperCase(),
+                    suggestedMaxAmount: input.variablePricing.suggestedMaxAmount,
+                }
+                : {
                     type: 'LEGACY',
                     amount: input.amount.value,
                     currency: input.amount.currency.toUpperCase(),
-                },
+                };
+            const agreement = await post('/recurring/v3/agreements', {
+                pricing,
                 interval: {
                     unit: (input.interval?.unit ?? 'month').toUpperCase(),
                     count: input.interval?.count ?? 1,
@@ -212,9 +221,16 @@ export function createVippsProvider(options) {
             };
         },
         async chargeRecurringAgreement(agreementReference, input) {
+            // No `currency` field here: the charge schema at
+            // https://developer.vippsmobilepay.com/api/recurring/ has no such
+            // property -- the charge always uses the agreement's own currency, so
+            // sending one was a mismatch with the documented request body (fixed
+            // here, not merely renamed). For a VARIABLE agreement, Vipps enforces
+            // amount <= the payer's accepted max itself: a charge above it is
+            // held `DUE`, not rejected synchronously here, so this adapter does
+            // not duplicate that check.
             const charge = await post(`/recurring/v3/agreements/${agreementReference}/charges`, {
                 amount: input.amount.value,
-                currency: input.amount.currency.toUpperCase(),
                 transactionType: 'DIRECT_CAPTURE',
                 due: input.dueDate ?? tomorrowIsoDate(),
                 retryDays: 0,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wtfalch/payments",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "One PaymentProvider interface -- create a payment, capture, refund, set up and charge a recurring agreement, verify a webhook -- over Stripe and Vipps MobilePay. Holds no card data.",
   "repository": {
     "type": "git",