getAvailablePaymentMethods(params)

Returns the payment methods available for your organization’s checkout. Use it to decide which payment methods to render with initMethod().

This method covers checkouts that run through Primer. For Stripe checkouts, use Billing.stripe.getAvailablePaymentMethods().

Parameters

string

required

Your organization ID. This method doesn’t read configure().

string

required

The API base URL. Use https://billing.funnelfox.com unless you point to a custom backend.

string

ISO country code to check availability for.

Returns

A Promise<PaymentMethod[]> with the available payment methods: PAYMENT_CARD, PAYPAL, GOOGLE_PAY, or APPLE_PAY. When Apple Pay is available, the list leaves out Google Pay. The default checkout follows the same rule.

Example

import {
  Billing,
  PaymentMethod,
  getAvailablePaymentMethods,
} from '@funnelfox/billing';

const methods = await getAvailablePaymentMethods({
  orgId: 'your-org-id',
  baseUrl: 'https://billing.funnelfox.com',
  countryCode: 'US',
});

if (methods.includes(PaymentMethod.APPLE_PAY)) {
  await Billing.initMethod(
    PaymentMethod.APPLE_PAY,
    document.getElementById('apple-pay'),
    {
      orgId: 'your-org-id',
      priceId: 'price_123',
      externalId: 'user_456',
    }
  );
}

You can also call it as Billing.getAvailablePaymentMethods().

API reference

Webhook reference

Billing Web SDK

getAvailablePaymentMethods(params)

Parameters

Returns

Example

​Parameters

​Returns

​Example

Parameters

Returns

Example