PayPal

6. SUBSCRIPTION MODULE (UI prompt)

Module Entities (9)

Entity	Alias	Module	Global Schema
(1) Currency	*Currency*	CurrencyModule	PayPal
(2) FundingSource	*FundingSource*	FundingSourceModule	PayPal
(3) Merchant	*Merchant*	MerchantModule	PayPal
(4) PaymentMethod	*PaymentMethod*	SubscriptionModule	PayPal
(5) Subscription	*Subscription*	SubscriptionModule	PayPal
(6) SubscriptionPayment	*SubscriptionPayment*	SubscriptionModule	PayPal
(7) SubscriptionPlan	*SubscriptionPlan*	SubscriptionModule	PayPal
(8) Transaction	*Transaction*	TransactionModule	PayPal
(9) UserAccount	*UserAccount*	UserAccountModule	PayPal

Module Interfaces (30)

Remote Method	Local Method	Module	HTTP-Method	References
(1) /subscriptionpayment/subscription/{id}	*findAllSubscriptionPaymentOfSubscription(id)*	SubscriptionModule	*GET*	Subscription SubscriptionPayment
(2) /paymentmethod/{id}	*findPaymentMethodById(id)*	SubscriptionModule	*GET*	PaymentMethod
(3) /subscriptionpayment/transaction/{id}	*findAllSubscriptionPaymentOfTransaction(id)*	SubscriptionModule	*GET*	Transaction SubscriptionPayment
(4) /subscriptionpayment/currency/{id}	*findAllSubscriptionPaymentOfCurrency(id)*	SubscriptionModule	*GET*	Currency SubscriptionPayment
(5) /subscriptionplan/{id}	*findSubscriptionPlanById(id)*	SubscriptionModule	*GET*	SubscriptionPlan
(6) /subscriptionplan/currency/{id}	*findAllSubscriptionPlanOfCurrency(id)*	SubscriptionModule	*GET*	Currency SubscriptionPlan
(7) /subscriptionpayment	*findAllSubscriptionPayment()*	SubscriptionModule	*GET*	SubscriptionPayment
(8) /paymentmethod/fundingsource/{id}	*findAllPaymentMethodOfFundingSource(id)*	SubscriptionModule	*GET*	FundingSource PaymentMethod
(9) /subscription/{id}	*findSubscriptionById(id)*	SubscriptionModule	*GET*	Subscription
(10) /subscriptionpayment/{id}	*deleteSubscriptionPaymentById(id)*	SubscriptionModule	*DELETE*	SubscriptionPayment
(11) /subscription/useraccount/{id}	*findAllSubscriptionOfUserAccount(id)*	SubscriptionModule	*GET*	UserAccount Subscription
(12) /subscriptionpayment/{id}	*updateSubscriptionPaymentById(subscriptionpayment)*	SubscriptionModule	*PUT*	SubscriptionPayment
(13) /subscriptionplan/merchant/{id}	*findAllSubscriptionPlanOfMerchant(id)*	SubscriptionModule	*GET*	Merchant SubscriptionPlan
(14) /subscription/{id}	*updateSubscriptionById(subscription)*	SubscriptionModule	*PUT*	Subscription
(15) /subscription/subscriptionplan/{id}	*findAllSubscriptionOfSubscriptionPlan(id)*	SubscriptionModule	*GET*	SubscriptionPlan Subscription
(16) /paymentmethod	*insertPaymentMethod(paymentmethod)*	SubscriptionModule	*POST*	PaymentMethod
(17) /subscriptionplan/{id}	*deleteSubscriptionPlanById(id)*	SubscriptionModule	*DELETE*	SubscriptionPlan
(18) /subscription/paymentmethod/{id}	*findAllSubscriptionOfPaymentMethod(id)*	SubscriptionModule	*GET*	PaymentMethod Subscription
(19) /paymentmethod/{id}	*deletePaymentMethodById(id)*	SubscriptionModule	*DELETE*	PaymentMethod
(20) /paymentmethod/{id}	*updatePaymentMethodById(paymentmethod)*	SubscriptionModule	*PUT*	PaymentMethod
(21) /subscription	*insertSubscription(subscription)*	SubscriptionModule	*POST*	Subscription
(22) /paymentmethod/useraccount/{id}	*findAllPaymentMethodOfUserAccount(id)*	SubscriptionModule	*GET*	UserAccount PaymentMethod
(23) /subscriptionpayment/{id}	*findSubscriptionPaymentById(id)*	SubscriptionModule	*GET*	SubscriptionPayment
(24) /paymentmethod	*findAllPaymentMethod()*	SubscriptionModule	*GET*	PaymentMethod
(25) /subscription	*findAllSubscription()*	SubscriptionModule	*GET*	Subscription
(26) /subscription/{id}	*deleteSubscriptionById(id)*	SubscriptionModule	*DELETE*	Subscription
(27) /subscriptionplan	*findAllSubscriptionPlan()*	SubscriptionModule	*GET*	SubscriptionPlan
(28) /subscriptionplan/{id}	*updateSubscriptionPlanById(subscriptionplan)*	SubscriptionModule	*PUT*	SubscriptionPlan
(29) /subscriptionplan	*insertSubscriptionPlan(subscriptionplan)*	SubscriptionModule	*POST*	SubscriptionPlan
(30) /subscriptionpayment	*insertSubscriptionPayment(subscriptionpayment)*	SubscriptionModule	*POST*	SubscriptionPayment

6.1 PAYMENT METHOD

PaymentMethod

SubscriptionModule

PayPal

Properties (6)

Property	Type	Entity	Reference	Module
*(1) FundingSource*	*LONG*	PaymentMethod	FundingSource	FundingSourceModule
*(2) IsDefault*	*BOOL*	PaymentMethod
*(3) Label*	*STRING*	PaymentMethod
*(4) MethodType*	*STRING*	PaymentMethod
*(5) Priority*	*INT*	PaymentMethod
*(6) UserAccount*	*LONG*	PaymentMethod	UserAccount	UserAccountModule

Example:

final PaymentMethod paymentmethod = (PaymentMethod) invokeModule(SUBSCRIPTION_MODULE + "/paymentmethod/" + id, PaymentMethod.class);
if (paymentmethod != null) {
    final FundingSource fundingsource1 = (FundingSource) invokeModule(FUNDING_SOURCE_MODULE + "/fundingsource/" + paymentmethod.getFundingSource().getId(), FundingSource.class);
    if (fundingsource1 != null) {
        final UserAccount useraccount2 = (UserAccount) invokeModule(USER_ACCOUNT_MODULE + "/useraccount/" + fundingsource1.getUserAccount().getId(), UserAccount.class);
        if (useraccount2 != null) {
        }
    }
    final UserAccount useraccount3 = (UserAccount) invokeModule(USER_ACCOUNT_MODULE + "/useraccount/" + paymentmethod.getUserAccount().getId(), UserAccount.class);
    if (useraccount3 != null) {
    }
}
return paymentmethod;

6.2 SUBSCRIPTION

Subscription

SubscriptionModule

PayPal

Properties (7)

Property	Type	Entity	Reference	Module
*(1) CancelledAt*	*DATE*	Subscription
*(2) EndDate*	*DATE*	Subscription
*(3) PaymentMethod*	*LONG*	Subscription	PaymentMethod	SubscriptionModule
*(4) StartDate*	*DATE*	Subscription
*(5) Status*	*STRING*	Subscription
*(6) SubscriptionPlan*	*LONG*	Subscription	SubscriptionPlan	SubscriptionModule
*(7) UserAccount*	*LONG*	Subscription	UserAccount	UserAccountModule

Example:

final Subscription subscription = (Subscription) invokeModule(SUBSCRIPTION_MODULE + "/subscription/" + id, Subscription.class);
if (subscription != null) {
    final UserAccount useraccount1 = (UserAccount) invokeModule(USER_ACCOUNT_MODULE + "/useraccount/" + subscription.getUserAccount().getId(), UserAccount.class);
    if (useraccount1 != null) {
    }
    final PaymentMethod paymentmethod2 = (PaymentMethod) invokeModule(SUBSCRIPTION_MODULE + "/paymentmethod/" + subscription.getPaymentMethod().getId(), PaymentMethod.class);
    if (paymentmethod2 != null) {
        final FundingSource fundingsource3 = (FundingSource) invokeModule(FUNDING_SOURCE_MODULE + "/fundingsource/" + paymentmethod2.getFundingSource().getId(), FundingSource.class);
        if (fundingsource3 != null) {
            final UserAccount useraccount4 = (UserAccount) invokeModule(USER_ACCOUNT_MODULE + "/useraccount/" + fundingsource3.getUserAccount().getId(), UserAccount.class);
            if (useraccount4 != null) {
            }
        }
        final UserAccount useraccount5 = (UserAccount) invokeModule(USER_ACCOUNT_MODULE + "/useraccount/" + paymentmethod2.getUserAccount().getId(), UserAccount.class);
        if (useraccount5 != null) {
        }
    }
    final SubscriptionPlan subscriptionplan6 = (SubscriptionPlan) invokeModule(SUBSCRIPTION_MODULE + "/subscriptionplan/" + subscription.getSubscriptionPlan().getId(), SubscriptionPlan.class);
    if (subscriptionplan6 != null) {
        final Merchant merchant7 = (Merchant) invokeModule(MERCHANT_MODULE + "/merchant/" + subscriptionplan6.getMerchant().getId(), Merchant.class);
        if (merchant7 != null) {
            final UserAccount useraccount8 = (UserAccount) invokeModule(USER_ACCOUNT_MODULE + "/useraccount/" + merchant7.getUserAccount().getId(), UserAccount.class);
            if (useraccount8 != null) {
            }
        }
        final Currency currency9 = (Currency) invokeModule(CURRENCY_MODULE + "/currency/" + subscriptionplan6.getCurrency().getId(), Currency.class);
        if (currency9 != null) {
        }
    }
}
return subscription;

6.3 SUBSCRIPTION PAYMENT

SubscriptionPayment

SubscriptionModule

PayPal

Properties (6)

Property	Type	Entity	Reference	Module
*(1) Amount*	*DOUBLE*	SubscriptionPayment
*(2) ChargeDate*	*DATE*	SubscriptionPayment
*(3) Currency*	*LONG*	SubscriptionPayment	Currency	CurrencyModule
*(4) Status*	*STRING*	SubscriptionPayment
*(5) Subscription*	*LONG*	SubscriptionPayment	Subscription	SubscriptionModule
*(6) Transaction*	*LONG*	SubscriptionPayment	Transaction	TransactionModule

Example:

final SubscriptionPayment subscriptionpayment = (SubscriptionPayment) invokeModule(SUBSCRIPTION_MODULE + "/subscriptionpayment/" + id, SubscriptionPayment.class);
if (subscriptionpayment != null) {
    final Transaction transaction1 = (Transaction) invokeModule(TRANSACTION_MODULE + "/transaction/" + subscriptionpayment.getTransaction().getId(), Transaction.class);
    if (transaction1 != null) {
        final Merchant merchant2 = (Merchant) invokeModule(MERCHANT_MODULE + "/merchant/" + transaction1.getMerchant().getId(), Merchant.class);
        if (merchant2 != null) {
            final UserAccount useraccount3 = (UserAccount) invokeModule(USER_ACCOUNT_MODULE + "/useraccount/" + merchant2.getUserAccount().getId(), UserAccount.class);
            if (useraccount3 != null) {
            }
        }
        final FundingSource fundingsource4 = (FundingSource) invokeModule(FUNDING_SOURCE_MODULE + "/fundingsource/" + transaction1.getFundingSource().getId(), FundingSource.class);
        if (fundingsource4 != null) {
            final UserAccount useraccount5 = (UserAccount) invokeModule(USER_ACCOUNT_MODULE + "/useraccount/" + fundingsource4.getUserAccount().getId(), UserAccount.class);
            if (useraccount5 != null) {
            }
        }
        final Fee feeamount6 = (Fee) invokeModule(CURRENCY_MODULE + "/fee/" + transaction1.getFeeAmount().getId(), Fee.class);
        if (feeamount6 != null) {
            final Currency currency7 = (Currency) invokeModule(CURRENCY_MODULE + "/currency/" + feeamount6.getCurrency().getId(), Currency.class);
            if (currency7 != null) {
            }
            final FeeSchedule feeschedule8 = (FeeSchedule) invokeModule(CURRENCY_MODULE + "/feeschedule/" + feeamount6.getFeeSchedule().getId(), FeeSchedule.class);
            if (feeschedule8 != null) {
                final Currency currency9 = (Currency) invokeModule(CURRENCY_MODULE + "/currency/" + feeschedule8.getCurrency().getId(), Currency.class);
                if (currency9 != null) {
                }
            }
        }
        final Currency currency10 = (Currency) invokeModule(CURRENCY_MODULE + "/currency/" + transaction1.getCurrency().getId(), Currency.class);
        if (currency10 != null) {
        }
    }
    final Subscription subscription11 = (Subscription) invokeModule(SUBSCRIPTION_MODULE + "/subscription/" + subscriptionpayment.getSubscription().getId(), Subscription.class);
    if (subscription11 != null) {
        final UserAccount useraccount12 = (UserAccount) invokeModule(USER_ACCOUNT_MODULE + "/useraccount/" + subscription11.getUserAccount().getId(), UserAccount.class);
        if (useraccount12 != null) {
        }
        final PaymentMethod paymentmethod13 = (PaymentMethod) invokeModule(SUBSCRIPTION_MODULE + "/paymentmethod/" + subscription11.getPaymentMethod().getId(), PaymentMethod.class);
        if (paymentmethod13 != null) {
            final FundingSource fundingsource14 = (FundingSource) invokeModule(FUNDING_SOURCE_MODULE + "/fundingsource/" + paymentmethod13.getFundingSource().getId(), FundingSource.class);
            if (fundingsource14 != null) {
                final UserAccount useraccount15 = (UserAccount) invokeModule(USER_ACCOUNT_MODULE + "/useraccount/" + fundingsource14.getUserAccount().getId(), UserAccount.class);
                if (useraccount15 != null) {
                }
            }
            final UserAccount useraccount16 = (UserAccount) invokeModule(USER_ACCOUNT_MODULE + "/useraccount/" + paymentmethod13.getUserAccount().getId(), UserAccount.class);
            if (useraccount16 != null) {
            }
        }
        final SubscriptionPlan subscriptionplan17 = (SubscriptionPlan) invokeModule(SUBSCRIPTION_MODULE + "/subscriptionplan/" + subscription11.getSubscriptionPlan().getId(), SubscriptionPlan.class);
        if (subscriptionplan17 != null) {
            final Merchant merchant18 = (Merchant) invokeModule(MERCHANT_MODULE + "/merchant/" + subscriptionplan17.getMerchant().getId(), Merchant.class);
            if (merchant18 != null) {
                final UserAccount useraccount19 = (UserAccount) invokeModule(USER_ACCOUNT_MODULE + "/useraccount/" + merchant18.getUserAccount().getId(), UserAccount.class);
                if (useraccount19 != null) {
                }
            }
            final Currency currency20 = (Currency) invokeModule(CURRENCY_MODULE + "/currency/" + subscriptionplan17.getCurrency().getId(), Currency.class);
            if (currency20 != null) {
            }
        }
    }
    final Currency currency21 = (Currency) invokeModule(CURRENCY_MODULE + "/currency/" + subscriptionpayment.getCurrency().getId(), Currency.class);
    if (currency21 != null) {
    }
}
return subscriptionpayment;

6.4 SUBSCRIPTION PLAN

SubscriptionPlan

SubscriptionModule

PayPal

Properties (9)

Property	Type	Entity	Reference	Module
*(1) Amount*	*DOUBLE*	SubscriptionPlan
*(2) BillingFrequency*	*INT*	SubscriptionPlan
*(3) BillingInterval*	*STRING*	SubscriptionPlan
*(4) Currency*	*LONG*	SubscriptionPlan	Currency	CurrencyModule
*(5) Description*	*STRING*	SubscriptionPlan
*(6) Merchant*	*LONG*	SubscriptionPlan	Merchant	MerchantModule
*(7) Name*	*STRING*	SubscriptionPlan
*(8) Status*	*STRING*	SubscriptionPlan
*(9) TrialDays*	*INT*	SubscriptionPlan

Example:

final SubscriptionPlan subscriptionplan = (SubscriptionPlan) invokeModule(SUBSCRIPTION_MODULE + "/subscriptionplan/" + id, SubscriptionPlan.class);
if (subscriptionplan != null) {
    final Merchant merchant1 = (Merchant) invokeModule(MERCHANT_MODULE + "/merchant/" + subscriptionplan.getMerchant().getId(), Merchant.class);
    if (merchant1 != null) {
        final UserAccount useraccount2 = (UserAccount) invokeModule(USER_ACCOUNT_MODULE + "/useraccount/" + merchant1.getUserAccount().getId(), UserAccount.class);
        if (useraccount2 != null) {
        }
    }
    final Currency currency3 = (Currency) invokeModule(CURRENCY_MODULE + "/currency/" + subscriptionplan.getCurrency().getId(), Currency.class);
    if (currency3 != null) {
    }
}
return subscriptionplan;