UsePlansOptions

SolvaPay SDK

---

SolvaPay SDK / react/src / UsePlansOptions

Interface: UsePlansOptions

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

Options for usePlans hook

Properties

agentRef?

optional agentRef: string

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

Agent reference to fetch plans for

---

autoSelectFirstPaid?

optional autoSelectFirstPaid: boolean

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

Auto-select first paid plan on load

---

fetcher()

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

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

Fetcher function to retrieve plans

Parameters

agentRef

string

Returns

Promise<Plan[]>

---

filter()?

optional filter: (plan) => boolean

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

Optional filter function to filter plans

Parameters

plan

Plan

Returns

boolean

---

sortBy()?

optional sortBy: (a, b) => number

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

Optional sort function to sort plans

Parameters

a

Plan

b

Plan

Returns

number