basalt / subscriptions/src / PaddleGatewayOptions
Interface: PaddleGatewayOptions
Defined in: subscriptions/src/drivers/paddle.ts:53
Properties
apiBase?
> optional apiBase?: string
Defined in: subscriptions/src/drivers/paddle.ts:74
API base, for tests/mocks. Default: https://api.paddle.com
apiKey
> apiKey: string
Defined in: subscriptions/src/drivers/paddle.ts:55
Paddle API key (Bearer).
customerId
> customerId: (billableId) => string | Promise<string>
Defined in: subscriptions/src/drivers/paddle.ts:61
Resolves (or ensures) the Paddle Customer ID (ctm_…) for a billable entity.
Parameters
billableId
string
Returns
string | Promise<string>
fetch?
> optional fetch?: (input, init?) => Promise<Response>
Defined in: subscriptions/src/drivers/paddle.ts:70
Injected fetch (tests). Default: global fetch.
Parameters
input
string | URL | Request
init?
RequestInit
Returns
Promise<Response>
now?
> optional now?: () => number
Defined in: subscriptions/src/drivers/paddle.ts:72
Clock in ms (tests). Default: Date.now.
Returns
number
priceId
> priceId: (plan, period) => string
Defined in: subscriptions/src/drivers/paddle.ts:59
Resolves the Paddle Price ID (pri_…) for a plan + billing period.
Parameters
plan
string
period
Returns
string
resolveBillableId?
> optional resolveBillableId?: (event) => string | undefined
Defined in: subscriptions/src/drivers/paddle.ts:66
Extracts the billable id from a verified event. Default: reads data.custom_data.billableId — which the create/checkout calls set.
Parameters
event
unknown
Returns
string | undefined
tolerance?
> optional tolerance?: number
Defined in: subscriptions/src/drivers/paddle.ts:68
Webhook timestamp tolerance in seconds. Default: 300 (5 minutes).
webhookSecret
> webhookSecret: string
Defined in: subscriptions/src/drivers/paddle.ts:57
Notification signing secret (pdl_ntfset_… / ntfset_…) used to verify webhooks.