PayableOptions

SolvaPay SDK

---

SolvaPay SDK / server/src / PayableOptions

Interface: PayableOptions

Defined in: packages/server/src/types/options.ts:49

Options for configuring payable protection

Properties

agent?

optional agent: string

Defined in: packages/server/src/types/options.ts:53

Agent identifier (auto-detected from package.json if not provided)

---

agentRef?

optional agentRef: string

Defined in: packages/server/src/types/options.ts:58

Agent reference (alias for agent, preferred for consistency with backend API)

---

getCustomerRef()?

optional getCustomerRef: (context) => string | Promise<string>

Defined in: packages/server/src/types/options.ts:73

Optional function to extract customer reference from context

Parameters

context

any

Returns

string | Promise<string>

---

plan?

optional plan: string

Defined in: packages/server/src/types/options.ts:63

Plan identifier (defaults to agent name if not provided)

---

planRef?

optional planRef: string

Defined in: packages/server/src/types/options.ts:68

Plan reference (alias for plan, preferred for consistency with backend API)