Skip to main content

UsePlansOptions

SolvaPay SDK v1.0.0


SolvaPay SDK / react/src / UsePlansOptions

Interface: UsePlansOptions

Defined in: packages/react/src/types/index.ts:231

Options for usePlans hook

Properties

autoSelectFirstPaid?

optional autoSelectFirstPaid: boolean

Defined in: packages/react/src/types/index.ts:251

Auto-select first paid plan on load


fetcher()

fetcher: (productRef) => Promise<Plan[]>

Defined in: packages/react/src/types/index.ts:235

Fetcher function to retrieve plans

Parameters

productRef

string

Returns

Promise<Plan[]>


filter()?

optional filter: (plan) => boolean

Defined in: packages/react/src/types/index.ts:243

Optional filter function to filter plans

Parameters

plan

Plan

Returns

boolean


productRef?

optional productRef: string

Defined in: packages/react/src/types/index.ts:239

Product reference to fetch plans for


sortBy()?

optional sortBy: (a, b) => number

Defined in: packages/react/src/types/index.ts:247

Optional sort function to sort plans

Parameters

a

Plan

b

Plan

Returns

number