basalt / subscriptions/src / StripeGatewayOptions
Interface: StripeGatewayOptions
Defined in: subscriptions/src/drivers/stripe.ts:40
Properties
apiBase?
> optional apiBase?: string
Defined in: subscriptions/src/drivers/stripe.ts:61
API base, for tests/mocks. Default: https://api.stripe.com
customerId
> customerId: (billableId) => string | Promise<string>
Defined in: subscriptions/src/drivers/stripe.ts:47
Resolves (or ensures) the Stripe Customer ID for a billable entity.
Parameters
billableId
string
Returns
string | Promise<string>
fetch?
> optional fetch?: (input, init?) => Promise<Response>
Defined in: subscriptions/src/drivers/stripe.ts:57
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/stripe.ts:59
Clock in ms (tests). Default: Date.now.
Returns
number
priceId
> priceId: (plan, period) => string
Defined in: subscriptions/src/drivers/stripe.ts:45
Resolves the Stripe Price ID for a plan + billing period.
Parameters
plan
string
period
Returns
string
resolveBillableId?
> optional resolveBillableId?: (event) => string | undefined
Defined in: subscriptions/src/drivers/stripe.ts:53
Extracts the billable id from a verified event. Default: reads data.object.metadata.billableId — which createSubscription sets on the subscription. Override for events whose object carries it elsewhere.
Parameters
event
unknown
Returns
string | undefined
secretKey
> secretKey: string
Defined in: subscriptions/src/drivers/stripe.ts:41
tolerance?
> optional tolerance?: number
Defined in: subscriptions/src/drivers/stripe.ts:55
Webhook timestamp tolerance in seconds. Default: 300 (5 minutes).
webhookSecret
> webhookSecret: string
Defined in: subscriptions/src/drivers/stripe.ts:43
The endpoint signing secret (whsec_...) used to verify webhooks.