Skip to main content
Version: 2.x

Class: CommerceService

Defined in: javascript/src/commerce/service.ts:339

Framework-independent catalog, billing-state, and provider coordinator.

Constructors​

Constructor​

new CommerceService(billing, credits, eventSink, options): CommerceService

Defined in: javascript/src/commerce/service.ts:344

Parameters​

billing​

BillingCapability

credits​

CommerceCredits

eventSink​

BillingEventSink

options​

CommerceOptions

Returns​

CommerceService

Properties​

autoRecharge​

readonly autoRecharge: CommerceAutoRecharge

Defined in: javascript/src/commerce/service.ts:340

billing​

readonly billing: BillingCapability

Defined in: javascript/src/commerce/service.ts:345

credits​

readonly credits: CommerceCredits

Defined in: javascript/src/commerce/service.ts:346

logger​

readonly logger: ReturnType<typeof normalizeLogger>

Defined in: javascript/src/commerce/service.ts:342

options​

readonly options: CommerceOptions

Defined in: javascript/src/commerce/service.ts:348

Methods​

cancelAllSubscriptions()​

cancelAllSubscriptions(input): Promise<CancelAllSubscriptionsResult>

Defined in: javascript/src/commerce/service.ts:656

Parameters​

input​
accountId​

string

operationKey​

string

Returns​

Promise<CancelAllSubscriptionsResult>

cancelScheduledPlanChange()​

cancelScheduledPlanChange(input): Promise<{ success: true; }>

Defined in: javascript/src/commerce/service.ts:1008

Parameters​

input​
accountId​

string

operationKey​

string

Returns​

Promise<{ success: true; }>

cancelSubscription()​

cancelSubscription(input): Promise<SubscriptionCommandResult>

Defined in: javascript/src/commerce/service.ts:589

Parameters​

input​
accountId​

string

operationKey​

string

Returns​

Promise<SubscriptionCommandResult>

clearProviderCache()​

clearProviderCache(): void

Defined in: javascript/src/commerce/service.ts:366

Returns​

void

confirmPlanChange()​

confirmPlanChange(input): Promise<ConfirmPlanChangeResult>

Defined in: javascript/src/commerce/service.ts:882

Parameters​

input​

ConfirmPlanChangeInput

Returns​

Promise<ConfirmPlanChangeResult>

createCheckout()​

createCheckout(input): Promise<CreateCheckoutResult>

Defined in: javascript/src/commerce/service.ts:435

Parameters​

input​

CreateCheckoutInput

Returns​

Promise<CreateCheckoutResult>

createPortalSession()​

createPortalSession(input): Promise<{ url: string; }>

Defined in: javascript/src/commerce/service.ts:1035

Parameters​

input​

PortalSessionInput

Returns​

Promise<{ url: string; }>

getAccountOverview()​

getAccountOverview(accountId): Promise<AccountCommerceOverview>

Defined in: javascript/src/commerce/service.ts:1126

Parameters​

accountId​

string

Returns​

Promise<AccountCommerceOverview>

getAccountSubscriptionSummary()​

getAccountSubscriptionSummary(accountId): Promise<AccountSubscriptionSummary>

Defined in: javascript/src/commerce/service.ts:775

Parameters​

accountId​

string

Returns​

Promise<AccountSubscriptionSummary>

getCheckoutStatus()​

getCheckoutStatus(input): Promise<{ intentId: string; status: "pending" | "succeeded" | "failed" | "expired"; }>

Defined in: javascript/src/commerce/service.ts:573

Parameters​

input​
intentId​

string

subjectId​

string

Returns​

Promise<{ intentId: string; status: "pending" | "succeeded" | "failed" | "expired"; }>

getInvoiceLink(input): Promise<{ url: string; }>

Defined in: javascript/src/commerce/service.ts:1316

Parameters​

input​

GetInvoiceLinkInput

Returns​

Promise<{ url: string; }>

handleWebhook()​

handleWebhook(input): Promise<WebhookResult>

Defined in: javascript/src/commerce/service.ts:1353

Parameters​

input​

CommerceWebhookInput

Returns​

Promise<WebhookResult>

previewPlanChange()​

previewPlanChange(input): Promise<PlanChangePreviewResult>

Defined in: javascript/src/commerce/service.ts:859

Parameters​

input​

PreviewPlanChangeInput

Returns​

Promise<PlanChangePreviewResult>

providerForAccount()​

providerForAccount(accountId, offer?): Promise<PaymentProvider>

Defined in: javascript/src/commerce/service.ts:426

Parameters​

accountId​

string

offer?​

CommerceOffer

Returns​

Promise<PaymentProvider>

reactivateSubscription()​

reactivateSubscription(input): Promise<SubscriptionCommandResult>

Defined in: javascript/src/commerce/service.ts:621

Parameters​

input​
accountId​

string

operationKey​

string

Returns​

Promise<SubscriptionCommandResult>

updatePreferences()​

updatePreferences(input): Promise<BillingPreferences>

Defined in: javascript/src/commerce/service.ts:1092

Parameters​

input​
accountId​

string

patch​

PreferencePatch

Returns​

Promise<BillingPreferences>