createClientSession(params)

Creates a client session without rendering a UI. This function is used in advanced scenarios where you want to obtain a payment client token and order ID first, then handle the UI or payment flow manually. The session is a Primer session. For Stripe checkouts, use the Billing.stripe methods.

Parameters

string

required

The price point identifier.

string

required

The customer’s external ID (your user ID).

string

Customer’s email address.

string

Organization ID, if not configured globally. Not needed if you already called configure().

string

ISO country code of the customer.

object

Custom metadata attached to the order.

object

Per-call API settings: baseUrl and region. These override the values from configure().

Returns

A Promise resolving to { clientToken, orderId, type }:

clientToken: The token to use with Primer’s Headless Checkout.
orderId: The order identifier in FunnelFox Payments.
type: Always 'session_created'.

Example

import { createClientSession } from '@funnelfox/billing';

const session = await createClientSession({
  priceId: 'price_123',
  externalId: 'user_456',
  email: 'user@example.com',
  orgId: 'your-org-id', // Optional if configured
});

console.log(session.clientToken); // Use with Primer Headless Checkout
console.log(session.orderId);

API reference

Webhook reference

Billing Web SDK

createClientSession(params)

Parameters

Returns

Example

​Parameters

​Returns

​Example

Parameters

Returns

Example