Interface: BillingCapability

Defined in: javascript/src/billing/contracts.ts:144

Application-facing billing capability exposed by Bursar.

Extends

• BillingEventSink

Properties

autoRecharge

readonly autoRecharge: AutoRechargeService

Defined in: javascript/src/billing/contracts.ts:145

---

hasProvisioning

readonly hasProvisioning: boolean

Defined in: javascript/src/billing/contracts.ts:146

Methods

claimAutoRechargeAttempt()

claimAutoRechargeAttempt(input): Promise<BillingAutoRechargeAttempt | null>

Defined in: javascript/src/billing/contracts.ts:177

Parameters

input

AutoRechargeAttemptClaim

Returns

Promise<BillingAutoRechargeAttempt | null>

---

countAutoRechargeAttempts()

countAutoRechargeAttempts(userId, since): Promise<number>

Defined in: javascript/src/billing/contracts.ts:184

Parameters

userId

string

since

string | Date

Returns

Promise<number>

---

createBillingSubscriptionChange()

createBillingSubscriptionChange(input): Promise<BillingSubscriptionChange>

Defined in: javascript/src/billing/contracts.ts:158

Parameters

input

BillingSubscriptionChangeInput

Returns

Promise<BillingSubscriptionChange>

---

createOrGetCheckoutIntent()

createOrGetCheckoutIntent(input): Promise<CheckoutIntent>

Defined in: javascript/src/billing/contracts.ts:147

Parameters

input

CheckoutIntentCreate

Returns

Promise<CheckoutIntent>

---

expirePastDueGracePeriods()

expirePastDueGracePeriods(now?): Promise<number>

Defined in: javascript/src/billing/contracts.ts:185

Parameters

now?

Date

Returns

Promise<number>

---

getActiveCatalogDocument()

getActiveCatalogDocument(): Promise<Record<string, unknown> | null>

Defined in: javascript/src/billing/contracts.ts:154

Returns

Promise<Record<string, unknown> | null>

---

getActiveSubscription()

getActiveSubscription(userId): Promise<BillingSubscriptionState | null>

Defined in: javascript/src/billing/contracts.ts:151

Parameters

userId

string

Returns

Promise<BillingSubscriptionState | null>

---

getAutoRechargeProfile()

getAutoRechargeProfile(userId): Promise<BillingAutoRechargeProfile | null>

Defined in: javascript/src/billing/contracts.ts:172

Parameters

userId

string

Returns

Promise<BillingAutoRechargeProfile | null>

---

getBlockingSubscription()

getBlockingSubscription(userId): Promise<BillingSubscriptionState | null>

Defined in: javascript/src/billing/contracts.ts:152

Parameters

userId

string

Returns

Promise<BillingSubscriptionState | null>

---

getCheckoutIntent()

getCheckoutIntent(id, subjectId): Promise<CheckoutIntent | null>

Defined in: javascript/src/billing/contracts.ts:149

Parameters

id

string

subjectId

string

Returns

Promise<CheckoutIntent | null>

---

getCustomerByUserId()

getCustomerByUserId(userId, provider?): Promise<BillingCustomerRecord | null>

Defined in: javascript/src/billing/contracts.ts:187

Parameters

userId

string

provider?

string | null

Returns

Promise<BillingCustomerRecord | null>

---

getOpenBillingSubscriptionChange()

getOpenBillingSubscriptionChange(provider, providerSubscriptionId): Promise<BillingSubscriptionChange | null>

Defined in: javascript/src/billing/contracts.ts:161

Parameters

provider

string

providerSubscriptionId

string

Returns

Promise<BillingSubscriptionChange | null>

---

getUserPreferences()

getUserPreferences(userId): Promise<BillingPreferences | null>

Defined in: javascript/src/billing/contracts.ts:153

Parameters

userId

string

Returns

Promise<BillingPreferences | null>

---

getUserSubscription()

getUserSubscription(userId): Promise<BillingSubscriptionState | null>

Defined in: javascript/src/billing/contracts.ts:150

Parameters

userId

string

Returns

Promise<BillingSubscriptionState | null>

---

ingestBillingEvent()

ingestBillingEvent(event): Promise<BillingEventResult>

Defined in: javascript/src/billing/contracts.ts:140

Parameters

event

BillingEvent

Returns

Promise<BillingEventResult>

Inherited from

BillingEventSink.ingestBillingEvent

---

invalidateOfferCache()

invalidateOfferCache(): void

Defined in: javascript/src/billing/contracts.ts:186

Returns

void

---

listBillingInvoices()

listBillingInvoices(userId): Promise<BillingInvoiceRecord[]>

Defined in: javascript/src/billing/contracts.ts:157

Parameters

userId

string

Returns

Promise<BillingInvoiceRecord[]>

---

listCancellableProviderSubscriptionIds()

listCancellableProviderSubscriptionIds(userId): Promise<string[]>

Defined in: javascript/src/billing/contracts.ts:155

Parameters

userId

string

Returns

Promise<string[]>

---

listCancellableSubscriptions()

listCancellableSubscriptions(userId): Promise<BillingSubscriptionState[]>

Defined in: javascript/src/billing/contracts.ts:156

Parameters

userId

string

Returns

Promise<BillingSubscriptionState[]>

---

pseudonymizeFinancialSubject()

pseudonymizeFinancialSubject(userId): Promise<void>

Defined in: javascript/src/billing/contracts.ts:209

Parameters

userId

string

Returns

Promise<void>

---

recordSubscriptionConflict()

recordSubscriptionConflict(input): Promise<void>

Defined in: javascript/src/billing/contracts.ts:169

Parameters

input

BillingSubscriptionConflictCreate

Returns

Promise<void>

---

resolveOffer()

resolveOffer(provider, productId?, priceId?): Promise<BillingOfferResult | null>

Defined in: javascript/src/billing/contracts.ts:191

Parameters

provider

string

productId?

string | null

priceId?

string | null

Returns

Promise<BillingOfferResult | null>

---

resolveOfferByLookup()

resolveOfferByLookup(provider, lookupKey): Promise<BillingOfferResult | null>

Defined in: javascript/src/billing/contracts.ts:196

Parameters

provider

string

lookupKey

string

Returns

Promise<BillingOfferResult | null>

---

resolveTopup()

resolveTopup(provider, productId?, priceId?): Promise<BillingTopupResult | null>

Defined in: javascript/src/billing/contracts.ts:197

Parameters

provider

string

productId?

string | null

priceId?

string | null

Returns

Promise<BillingTopupResult | null>

---

resolveTopupByLookup()

resolveTopupByLookup(provider, lookupKey): Promise<BillingTopupResult | null>

Defined in: javascript/src/billing/contracts.ts:202

Parameters

provider

string

lookupKey

string

Returns

Promise<BillingTopupResult | null>

---

updateAutoRechargeAttempt()

updateAutoRechargeAttempt(input): Promise<void>

Defined in: javascript/src/billing/contracts.ts:180

Parameters

input

AutoRechargeAttemptUpdate

Returns

Promise<void>

---

updateAutoRechargeAttemptByProviderPayment()

updateAutoRechargeAttemptByProviderPayment(input): Promise<void>

Defined in: javascript/src/billing/contracts.ts:181

Parameters

input

AutoRechargeProviderPaymentUpdate

Returns

Promise<void>

---

updateBillingSubscriptionChange()

updateBillingSubscriptionChange(id, update): Promise<void>

Defined in: javascript/src/billing/contracts.ts:165

Parameters

id

string

update

BillingSubscriptionChangeUpdate

Returns

Promise<void>

---

updateCheckoutIntent()

updateCheckoutIntent(id, update): Promise<void>

Defined in: javascript/src/billing/contracts.ts:148

Parameters

id

string

update

CheckoutIntentUpdate

Returns

Promise<void>

---

updateUserPreferences()

updateUserPreferences(preferences): Promise<void>

Defined in: javascript/src/billing/contracts.ts:171

Parameters

preferences

BillingPreferences

Returns

Promise<void>

---

upsertAutoRechargeProfile()

upsertAutoRechargeProfile(profile, options?): Promise<void>

Defined in: javascript/src/billing/contracts.ts:173

Parameters

profile

BillingAutoRechargeProfile

options?

resetCooldown?

boolean

Returns

Promise<void>

---

upsertBillingSubscription()

upsertBillingSubscription(state): Promise<void>

Defined in: javascript/src/billing/contracts.ts:170

Parameters

state

BillingSubscriptionState

Returns

Promise<void>

---

upsertCustomer()

upsertCustomer(provider, providerCustomerId, userId, email?): Promise<void>

Defined in: javascript/src/billing/contracts.ts:203

Parameters

provider

string

providerCustomerId

string

userId

string

email?

string | null

Returns

Promise<void>