Skip to main content
Vindicia Knowledge Center

BillingPlan.fetchByMerchantEntitlementId

BillingPlan.fetchByMerchantEntitlementId

BillingPlan.fetchByMerchantEntitlementId

The fetchByMerchantEntitlementId method returns one or more BillingPlan objects that offer an entitlement whose ID matches the input. For example, call this method if a customer would like to see all the billing plans which grant a specific privilege on your site.

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.

merchantEntitlementId: the merchant’s unique ID for the Entitlement.

Output

return: an object of type Return that indicates the success or failure of the call.

billingPlans: an array of one or more BillingPlan objects with an entitlement whose ID matches the input.

Returns

In addition to those listed in Standard Return Codes, this call returns:

Return Code

Return String

404

No BillingPlans found for entitlementId input-merchantEntitlementId.

Example

$plan = new BillingPlan();

// now load all billing plans that have an
// entitlement id of download $meId = 'Gold Access';
// This is the id we want to retrieve plans by

$response = $plan->fetchByMerchantEntitlementId($meId);

if($response['returnCode'] == 200) {

$fetchedPlans = $response['data']->billingPlans;

if ($fetchedPlans != null ) {

foreach ($fetchedPlans as $billPlan) {

// process a fetched plan here

}

}

}

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top