AutoBill.grantCredit

• Token-based credit may be granted to an AutoBill to pay for billing transactions. To grant Token-based credit to an AutoBill, the credit must be of the same token type as the Payment Method on the AutoBill, and the BillingPlan must also be defined in terms of the same Token Type. Token Credits granted will be deducted from the amount billed to the AutoBill’s payment method at the next billing cycle.
• You may also grant time-based credit to an AutoBill. With a TimeInterval object, define a time extension to be given to an AutoBill in terms of years, months, weeks, or days. When you grant time credit to an AutoBill, Subscribe delays the next billing for the AutoBill by the specified amount of time, similar to calling delayBillingByDays() on an AutoBill object. This delay does not occur until the billing date following the time credit grant. Until then, the time credit remains on the AutoBill, and the next billing date appears unchanged. Note that Subscribe does not generate a transaction to account for such a time-based credit grant.
• When granting a currency credit to an AutoBill, the currency (i.e. USD) for the credit grants must be the same as the currency the customer has specified for the AutoBill.
• Time and Currency Credits may be tracked by timestamp and sortValue. When granted, they are assigned a VID, which may be used when revoking credit.

​

Input

​

Output

​

Returns

​

Example

$abill = new AutoBill();

// autobill id for an existing subscription

$abill->set('SBCR312345');

// We want to grant 2 days of credit
$time = new TimeInterval();
$time->setDays(’2’);

$cr = new Credit();
$cr->setTimeIntervals(array($time));
$note = “optional note explaining credit grant”;

// Now make the SOAP API call to grant credit to the autobill
$response = $abill->grantCredit($cr,$note);

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

   // Credit successfully granted to the autobill

   $updatedABill = $response['data']->autobill;
   print "Current entitlements are valid till: ";
   print $updatedABill->getEndDate() . "\n";

}
else {
   // Error while granting credit to the account

   print $response['returnString'] . "\n";
}