Class SmartyPaySubscriptions

Index

Constructors

Methods

createCustomerToken createSubscription getActivePlan getActivePlans getPlans getSubscription getSubscriptionCharges getSubscriptionsByCustomer getSubscriptionsByPayer

Constructors

constructor

new SmartyPaySubscriptions(apiOpt): SmartyPaySubscriptions
Parameters
- apiOpt: SubsApiOpt
Returns SmartyPaySubscriptions
- Defined in src/subscription/SmartyPaySubscriptions.ts:28

Methods

createCustomerToken

createCustomerToken(__namedParameters): Promise<string>
Create session token for external subscription widget access
Parameters
- __namedParameters: CreateCustomerTokenReq
Returns Promise<string>
- Defined in src/subscription/SmartyPaySubscriptions.ts:121

createSubscription

createSubscription(req): Promise<Subscription>
Create subscription for payer
Parameters
- req: CreateSubscriptionReq
Returns Promise<Subscription>
- Defined in src/subscription/SmartyPaySubscriptions.ts:60

getActivePlan

getActivePlan(planId): Promise<undefined | SubscriptionPlan>
Get active subscription plan by id
Parameters
- planId: string
Returns Promise<undefined | SubscriptionPlan>
- Defined in src/subscription/SmartyPaySubscriptions.ts:52

getActivePlans

getActivePlans(): Promise<SubscriptionPlan[]>
Get active subscriptions plans

Returns Promise<SubscriptionPlan[]>
- Defined in src/subscription/SmartyPaySubscriptions.ts:45

getPlans

getPlans(statusIn): Promise<SubscriptionPlan[]>
Get subscriptions plans in target statuses
Parameters
- statusIn: SubscriptionPlanStatus[]
Returns Promise<SubscriptionPlan[]>
- Defined in src/subscription/SmartyPaySubscriptions.ts:34

getSubscription

getSubscription(__namedParameters): Promise<Subscription>
Get subscription by its contractAddress
Parameters
- __namedParameters: SubscriptionId
Returns Promise<Subscription>
- Defined in src/subscription/SmartyPaySubscriptions.ts:103

getSubscriptionCharges

getSubscriptionCharges(__namedParameters): Promise<SubscriptionCharge[]>
Get subscription's charges by its contractAddress
Parameters
- __namedParameters: SubscriptionId
Returns Promise<SubscriptionCharge[]>
- Defined in src/subscription/SmartyPaySubscriptions.ts:110

getSubscriptionsByCustomer

getSubscriptionsByCustomer(customerId): Promise<Subscription[]>
Get subscriptions by customer id
Parameters
- customerId: string
Returns Promise<Subscription[]>
- Defined in src/subscription/SmartyPaySubscriptions.ts:79

getSubscriptionsByPayer

getSubscriptionsByPayer(payerAddress): Promise<Subscription[]>
Get subscriptions for payer address
Parameters
- payerAddress: string
Returns Promise<Subscription[]>
- Defined in src/subscription/SmartyPaySubscriptions.ts:91