Interface StiggManagementAPI

Hierarchy

StiggManagementAPI

Implemented by

Stigg

Methods

applySubscription

applySubscription(params: ApplySubscription): Promise<ApplySubscriptionResults>

- Defined in src/client.ts:103
Parameters
- params: ApplySubscription
Returns Promise<ApplySubscriptionResults>

archiveCustomer

archiveCustomer(customerId: string): Promise<string>

- Defined in src/client.ts:90
Parameters
- customerId: string
Returns Promise<string>

cancelSubscription

cancelSubscription(cancelSubscription: CancelSubscription): Promise<Subscription>

- Defined in src/client.ts:96
Parameters
- cancelSubscription: CancelSubscription
Returns Promise<Subscription>

cancelSubscriptionScheduledUpdates

cancelSubscriptionScheduledUpdates(cancelSubscriptionScheduledUpdates: CancelSubscriptionScheduledUpdates): Promise<{ subscriptionId: string }>

- Defined in src/client.ts:97
Parameters
- cancelSubscriptionScheduledUpdates: CancelSubscriptionScheduledUpdates
Returns Promise<{ subscriptionId: string }>

createCustomer

createCustomer(params: CreateCustomer): Promise<SlimCustomer>

- Defined in src/client.ts:86
deprecated
use provisionCustomer instead to create both customer and subscription in single operation. See provisionCustomer for more info.

Parameters
- params: CreateCustomer
Returns Promise<SlimCustomer>

createSubscription

createSubscription(createSubscription: CreateSubscription): Promise<Subscription>

- Defined in src/client.ts:102
deprecated
use provisionSubscription instead to create subscription or checkout session according to customer and subscription payment requirements. See provisionSubscription for more info.

Parameters
- createSubscription: CreateSubscription
Returns Promise<Subscription>

detachCustomerPaymentMethod

detachCustomerPaymentMethod(customerId: string): Promise<SlimCustomer>

- Defined in src/client.ts:88
Parameters
- customerId: string
Returns Promise<SlimCustomer>

estimateSubscription

estimateSubscription(estimateSubscription: EstimateSubscription): Promise<SubscriptionPreview>

- Defined in src/client.ts:113
Parameters
- estimateSubscription: EstimateSubscription
Returns Promise<SubscriptionPreview>

estimateSubscriptionUpdate

estimateSubscriptionUpdate(estimateSubscriptionUpdate: EstimateSubscriptionUpdate): Promise<SubscriptionPreview>

- Defined in src/client.ts:115
Parameters
- estimateSubscriptionUpdate: EstimateSubscriptionUpdate
Returns Promise<SubscriptionPreview>

getActiveSubscriptions

getActiveSubscriptions(params: GetActiveSubscriptions): Promise<FullSubscription[]>

- Defined in src/client.ts:109
Parameters
- params: GetActiveSubscriptions
Returns Promise<FullSubscription[]>

getCoupons

getCoupons(): Promise<Coupon[]>

- Defined in src/client.ts:107
Returns Promise<Coupon[]>

getCustomer

getCustomer(customerId: string): Promise<FullCustomer>

- Defined in src/client.ts:89
Parameters
- customerId: string
Returns Promise<FullCustomer>

getCustomerStatistics

getCustomerStatistics(customerId: string): Promise<CustomerStatisticsModel>

- Defined in src/client.ts:125
Parameters
- customerId: string
Returns Promise<CustomerStatisticsModel>

getPaywall

getPaywall(params?: GetPaywall): Promise<Paywall>

- Defined in src/client.ts:105
Parameters
- Optional params: GetPaywall
Returns Promise<Paywall>

getProducts

getProducts(): Promise<Product[]>

- Defined in src/client.ts:111
Returns Promise<Product[]>

grantPromotionalEntitlements

grantPromotionalEntitlements(input: GrantPromotionalEntitlementsInput): Promise<PromotionalEntitlementFragment[]>

- Defined in src/client.ts:121
Parameters
- input: GrantPromotionalEntitlementsInput
Returns Promise<PromotionalEntitlementFragment[]>

importCustomer

importCustomer(params: ImportCustomer): Promise<SlimCustomer>

- Defined in src/client.ts:92
Parameters
- params: ImportCustomer
Returns Promise<SlimCustomer>

importCustomerBulk

importCustomerBulk(params: ImportCustomerBulk): Promise<void>

- Defined in src/client.ts:93
Parameters
- params: ImportCustomerBulk
Returns Promise<void>

importSubscriptionBulk

importSubscriptionBulk(params: ImportSubscriptionBulk): Promise<void>

- Defined in src/client.ts:94
Parameters
- params: ImportSubscriptionBulk
Returns Promise<void>

previewSubscription

previewSubscription(previewSubscription: PreviewSubscription): Promise<SubscriptionPreviewV2>

- Defined in src/client.ts:117
Parameters
- previewSubscription: PreviewSubscription
Returns Promise<SubscriptionPreviewV2>

provisionCustomer

provisionCustomer(params: ProvisionCustomer): Promise<ProvisionedCustomer>

- Defined in src/client.ts:84
Parameters
- params: ProvisionCustomer
Returns Promise<ProvisionedCustomer>

provisionSubscription

provisionSubscription(provisionSubscription: ProvisionSubscription): Promise<ProvisionSubscriptionResult>

- Defined in src/client.ts:100
Parameters
- provisionSubscription: ProvisionSubscription
Returns Promise<ProvisionSubscriptionResult>

revokePromotionalEntitlements

revokePromotionalEntitlements(input: RevokePromotionalEntitlementInput): Promise<{ id: string }>

- Defined in src/client.ts:123
Parameters
- input: RevokePromotionalEntitlementInput
Returns Promise<{ id: string }>

transferSubscription

transferSubscription(input: TransferSubscriptionInput): Promise<Subscription>

- Defined in src/client.ts:119
Parameters
- input: TransferSubscriptionInput
Returns Promise<Subscription>

unarchiveCustomer

unarchiveCustomer(customerId: string): Promise<SlimCustomer>

- Defined in src/client.ts:91
Parameters
- customerId: string
Returns Promise<SlimCustomer>

updateCustomer

updateCustomer(params: UpdateCustomer): Promise<SlimCustomer>

- Defined in src/client.ts:87
Parameters
- params: UpdateCustomer
Returns Promise<SlimCustomer>

updateSubscription

updateSubscription(updateSubscription: UpdateSubscription): Promise<Subscription>

- Defined in src/client.ts:95
Parameters
- updateSubscription: UpdateSubscription
Returns Promise<Subscription>

Generated using TypeDoc