BillingPlan.fetchByMerchantBillingPlanId

The fetchByMerchantBillingPlanId method returns a BillingPlan object whose ID, assigned by you, matches the input.

Input

srd: sparse response description, a SOAP string (which must be a JSON object), in which you specify the elements you want returned.This parameter enables the calling system to constrain a method call to return only components you specify. This gives you greater control over returned content, and improves response time within the Vindicia platform by reducing the processing needed for the call. Some fields are required, either practically or in the WSDL, and will be returned regardless of the srd. A null srd returns the complete response. merchantBillingPlanId: your billing plan ID (merchantBillingPlanId), which serves as the search criterion.

Output

return: an object of type Return that indicates the success or failure of the call. billingPlan: the BillingPlan object whose merchantBillingPlanId matches the input.

Returns

In addition to those listed in The Return Object, this call returns:

Return Code	Return String
404	No BillingPlans found for Merchant Billing Plan ID input-merchantBillingPlanId.

Example

$bpMerchantId = '12345';
 
// Create a billing plan object
$plan = new BillingPlan();
 
// now load a billing plan record into the Billing Plan object
$response = $plan->fetchByMerchantBillingPlanId($bpMerchantId);
if($response['returnCode'] == 200) {
$fetchedBillingPlan = $response['data']->billingPlan;
 
// process fetched billing plan here
}

Parent topic:BillingPlan Methods

Home

Guides

APIs

Input

Output

Returns

Example

​Input

​Output

​Returns

​Example

Input

Output

Returns

Example