Types

​

Imports

• Methods: configure, createCheckout, createClientSession, getAvailablePaymentMethods.
• Namespace: Billing (also the default export).
• Enum: PaymentMethod.
• Constants: EVENTS, CHECKOUT_STATES, ERROR_CODES, DEFAULTS, SDK_VERSION.
• Error classes: FunnefoxSDKError, APIError, NetworkError, PrimerError, CheckoutError, ValidationError, ConfigurationError.

​

Main types

​

TypeScript notes

• orgId in createCheckout(): The options type requires orgId, even after you call configure().
• Error classes: The type definitions declare them as interfaces, so instanceof doesn’t compile. Narrow errors by error.name instead. Learn more in Error handling.
• Events beyond the core four: on() accepts 'success', 'error', 'status-change', and 'destroy' as strings. For other events, such as purchase-failure, pass the EVENTS constant and cast the handler argument. Learn more about purchase-failure.
• Tax callbacks: onTaxChange receives a typed TaxInfo. Use the callbacks rather than events for tax updates.

​

Example

import { configure, createCheckout, PaymentMethod } from '@funnelfox/billing';
import type {
  CheckoutInstance,
  PaymentResult,
  TaxInfo,
} from '@funnelfox/billing';

configure({
  orgId: 'your-org-id',
});

const checkout: CheckoutInstance = await createCheckout({
  orgId: 'your-org-id',
  priceId: 'price_123',
  customer: {
    externalId: 'user_456',
    email: 'user@example.com',
    countryCode: 'US',
  },
  container: '#checkout',
  clientMetadata: {
    source: 'web',
    campaign: 'summer-sale',
  },
  paymentMethodOrder: [
    PaymentMethod.PAYPAL,
    PaymentMethod.PAYMENT_CARD,
    PaymentMethod.GOOGLE_PAY,
    PaymentMethod.APPLE_PAY,
  ],
  onTaxChange: (info: TaxInfo) => {
    console.log('Total:', info.amountTotal, info.currency);
  },
});

checkout.on('success', (result: PaymentResult) => {
  console.log('Order:', result.orderId);
  console.log('Status:', result.status);
});