BillingPlan

Methods

update http://soap.vindicia.com/BillingPlan#update

Input (update_in)

Name	Type
auth	Authentication
billingPlan	BillingPlan

Output (update_out)

Name	Type
return	Return
billingPlan	BillingPlan
created	xsd:boolean

Creates a new BillingPlan object or updates an existing one.

Input Fields

auth: Credentials required to authenticate this request
billingPlan: Object to create

Output Fields

return: Basic results of this request (success, failure, error, etc.)
billingPlan: The resultant object
created: True if the object was created new

fetchByVid http://soap.vindicia.com/BillingPlan#fetchByVid

Input (fetchByVid_in)

Name	Type
auth	Authentication
vid	xsd:string

Output (fetchByVid_out)

Name	Type
return	Return
billingPlan	BillingPlan

Loads a BillingPlan by Vindicia's unique ID

Input Fields

auth: Credentials required to authenticate this request
vid: Vindicia ID for the object

Output Fields

return: Basic results of this request (success, failure, error, etc.)
billingPlan: The resultant object

fetchByMerchantBillingPlanId http://soap.vindicia.com/BillingPlan#fetchByMerchantBillingPlanId

Input (fetchByMerchantBillingPlanId_in)

Name	Type
auth	Authentication
merchantBillingPlanId	xsd:string

Output (fetchByMerchantBillingPlanId_out)

Name	Type
return	Return
billingPlan	BillingPlan

Loads a BillingPlan by merchant's unique BillingPlan Id

Input Fields

auth: Credentials required to authenticate this request
merchantBillingPlanId: Merchant's BillingPlan Id for this object

Output Fields

return: Basic results of this request (success, failure, error, etc.)
billingPlan: The resultant object

fetchByBillingPlanStatus http://soap.vindicia.com/BillingPlan#fetchByBillingPlanStatus

Input (fetchByBillingPlanStatus_in)

Name	Type
auth	Authentication
status	BillingPlanStatus

Output (fetchByBillingPlanStatus_out)

Name	Type
return	Return
billingPlans	ArrayOfBillingPlans

Load a list of BillingPlans by status

Input Fields

auth: Credentials required to authenticate this request
status: The status of the BillingPlan

Output Fields

return: Basic results of this request (success, failure, error, etc.)
billingPlans: The resultant object

fetchAll http://soap.vindicia.com/BillingPlan#fetchAll

Input (fetchAll_in)

Name	Type
auth	Authentication
page	xsd:int
pageSize	xsd:int

Output (fetchAll_out)

Name	Type
return	Return
billingPlans	ArrayOfBillingPlans

Input Fields

auth: Credentials required to authenticate this request
page: The offset, based on pageSize, to return.
pageSize: The number of BillingPlans to return per page.

Output Fields

return: Basic results of this request (success, failure, error, etc.)
billingPlans: The resultant object

fetchByMerchantEntitlementId http://soap.vindicia.com/BillingPlan#fetchByMerchantEntitlementId

Input (fetchByMerchantEntitlementId_in)

Name	Type
auth	Authentication
merchantEntitlementId	xsd:string

Output (fetchByMerchantEntitlementId_out)

Name	Type
return	Return
billingPlans	ArrayOfBillingPlans

Loads all BillingPlans that grant an entitlement

Input Fields

auth: Credentials required to authenticate this request
merchantEntitlementId: Merchant's unique entitlement id

Output Fields

return: Basic results of this request (success, failure, error, etc.)
billingPlans: The resultant objects