Skip to content
Snippets Groups Projects
Commit 16f1f92e authored by mattwire's avatar mattwire
Browse files

Implement change subscription amount at Stripe from CiviCRM

parent d64ce518
Branches
Tags
No related merge requests found
Hide whitespace changes
Inline Side-by-side
CRM/Core/Payment/Stripe.php
+ 139
− 2
View file @ 16f1f92e
......@@ -32,6 +32,11 @@ class CRM_Core_Payment_Stripe extends CRM_Core_Payment {
*/
public $stripeClient;
/**
* @var \Civi\Stripe\Api;
*/
public \Civi\Stripe\Api $api;
/**
* Custom properties used by this payment processor
*
......@@ -48,6 +53,7 @@ class CRM_Core_Payment_Stripe extends CRM_Core_Payment {
*/
public function __construct($mode, $paymentProcessor) {
$this->_paymentProcessor = $paymentProcessor;
$this->api = new \Civi\Stripe\Api($this);
if (defined('STRIPE_PHPUNIT_TEST') && isset($GLOBALS['mockStripeClient'])) {
// When under test, prefer the mock.
......@@ -173,6 +179,10 @@ class CRM_Core_Payment_Stripe extends CRM_Core_Payment {
return TRUE;
}
public function supportsRecurring() {
return TRUE;
}
/**
* We can edit stripe recurring contributions
* @return bool
......@@ -181,8 +191,36 @@ class CRM_Core_Payment_Stripe extends CRM_Core_Payment {
return TRUE;
}
public function supportsRecurring() {
return TRUE;
/**
* Get an array of the fields that can be edited on the recurring contribution.
*
* Some payment processors support editing the amount and other scheduling details of recurring payments, especially
* those which use tokens. Others are fixed. This function allows the processor to return an array of the fields that
* can be updated from the contribution recur edit screen.
*
* The fields are likely to be a subset of these
* - 'amount',
* - 'installments',
* - 'frequency_interval',
* - 'frequency_unit',
* - 'cycle_day',
* - 'next_sched_contribution_date',
* - 'end_date',
* - 'failure_retry_day',
*
* The form does not restrict which fields from the contribution_recur table can be added (although if the html_type
* metadata is not defined in the xml for the field it will cause an error.
*
* Open question - would it make sense to return membership_id in this - which is sometimes editable and is on that
* form (UpdateSubscription).
*
* @return array
*/
public function getEditableRecurringScheduleFields() {
if ($this->supports('changeSubscriptionAmount')) {
return ['amount'];
}
return [];
}
/**
......@@ -1324,6 +1362,94 @@ class CRM_Core_Payment_Stripe extends CRM_Core_Payment {
return ['message' => E::ts('Successfully cancelled the subscription at Stripe.')];
}
/**
* Change the amount of the recurring payment.
*
* @param string $message
* @param array $params
*
* @return bool|object
*
* @throws \Civi\Payment\Exception\PaymentProcessorException
*/
public function changeSubscriptionAmount(&$message = '', $params = []) {
// We only support the following params: amount
try {
$propertyBag = $this->beginChangeSubscriptionAmount($params);
// Get the Stripe subscription
$subscription = $this->stripeClient->subscriptions->retrieve($propertyBag->getRecurProcessorID());
$calculatedItems = $this->api->calculateItemsForSubscription($propertyBag->getRecurProcessorID(), $subscription->items->data);
$contributionRecurKey = mb_strtolower($propertyBag->getCurrency()) . "_{$propertyBag->getRecurFrequencyUnit()}_{$propertyBag->getRecurFrequencyInterval()}";
if (isset($calculatedItems[$contributionRecurKey])) {
$calculatedItem = $calculatedItems[$contributionRecurKey];
if (Money::of($calculatedItem['amount'], mb_strtoupper($calculatedItem['currency']))
->isAmountAndCurrencyEqualTo(Money::of($propertyBag->getAmount(), $propertyBag->getCurrency()))) {
throw new PaymentProcessorException('Amount is the same as before!');
}
}
else {
throw new PaymentProcessorException('Cannot find existing price/plan for this subscription with matching frequency!');
}
// Get the existing Price
$existingPrice = $subscription->items->data[0]->price;
// Check if the Stripe Product already has a Price configured for the new amount
$priceToMatch = [
'active' => TRUE,
'currency' => $subscription->currency,
'product' => $existingPrice->product,
'type' => 'recurring',
'recurring' => [
'interval' => $existingPrice->recurring['interval'],
],
];
$existingPrices = $this->stripeClient->prices->all($priceToMatch);
foreach ($existingPrices as $price) {
if ($price->unit_amount === (int) $this->getAmountFormattedForStripeAPI($propertyBag)) {
// Yes, we already have a matching price option - use it!
$newPriceID = $price->id;
break;
}
}
if (empty($newPriceID)) {
// We didn't find an existing price that matched for the product. Create a new one.
$newPriceParameters = [
'currency' => $subscription->currency,
'unit_amount' => $this->getAmountFormattedForStripeAPI($propertyBag),
'product' => $existingPrice->product,
'metadata' => $existingPrice->metadata->toArray(),
'recurring' => [
'interval' => $existingPrice->recurring['interval'],
'interval_count' => $existingPrice->recurring['interval_count'],
],
];
$newPriceID = $this->stripeClient->prices->create($newPriceParameters)->id;
}
// Update the Stripe subscription, replacing the existing price with the new one.
$this->stripeClient->subscriptions->update($propertyBag->getRecurProcessorID(), [
'items' => [
[
'id' => $subscription->items->data[0]->id,
'price' => $newPriceID,
],
],
// See https://stripe.com/docs/billing/subscriptions/prorations - we disable this to keep it simple for now.
'proration_behavior' => 'none',
]);
}
catch (Exception $e) {
// On ANY failure, throw an exception which will be reported back to the user.
\Civi::log()->error('Update Subscription failed for RecurID: ' . $propertyBag->getContributionRecurID() . ' Error: ' . $e->getMessage());
throw new PaymentProcessorException('Update Subscription Failed: ' . $e->getMessage(), $e->getCode(), $params);
}
return TRUE;
}
/**
* Process incoming payment notification (IPN).
*
......@@ -1496,6 +1622,17 @@ class CRM_Core_Payment_Stripe extends CRM_Core_Payment {
return $text;
}
/**
* Get the help text to present on the recurring update page.
*
* This should reflect what can or cannot be edited.
*
* @return string
*/
public function getRecurringScheduleUpdateHelpText() {
return E::ts('Use this form to change the amount for this recurring contribution. The Stripe subscription will be updated with the new amount.');
}
/*
* Sets a mock stripe client object for this object and all future created
* instances. This should only be called by phpunit tests.
......
Civi/Api4/Action/StripeCharge/GetBalanceTransactionDetails.php
+ 1
− 2
View file @ 16f1f92e
......@@ -47,8 +47,7 @@ class GetBalanceTransactionDetails extends \Civi\Api4\Generic\AbstractAction {
throw new \CRM_Core_Exception('Missing paymentProcessorID');
}
$stripeApi = new \Civi\Stripe\Api();
$stripeApi->setPaymentProcessor($this->paymentProcessorID);
$stripeApi = new \Civi\Stripe\Api(\Civi\Payment\System::singleton()->getById($this->paymentProcessorID));
$charge = $stripeApi->getPaymentProcessor()->stripeClient->charges->retrieve($this->chargeID);
......
Civi/Stripe/Api.php
+ 47
− 0
View file @ 16f1f92e
......@@ -17,6 +17,10 @@ class Api {
use \CRM_Core_Payment_MJWIPNTrait;
public function __construct($paymentProcessor) {
$this->_paymentProcessor = $paymentProcessor;
}
/**
* @param string $name The key of the required value
* @param string $dataType The datatype of the required value (eg. String)
......@@ -76,4 +80,47 @@ class Api {
}
}
/**
* @param string $subscriptionID
* @param array $itemsData
* Array of \Stripe\SubscriptionItem
*
* @return array
* @throws \CRM_Core_Exception
* @throws \Civi\Payment\Exception\PaymentProcessorException
* @throws \Stripe\Exception\ApiErrorException
*/
public function calculateItemsForSubscription(string $subscriptionID, array $itemsData) {
$calculatedItems = [];
// Recalculate amount and update
foreach ($itemsData as $item) {
$subscriptionItem['subscriptionItemID'] = $this->getValueFromStripeObject('id', 'String', $item);
$subscriptionItem['quantity'] = $this->getValueFromStripeObject('quantity', 'Int', $item);
$subscriptionItem['unit_amount'] = $this->getValueFromStripeObject('unit_amount', 'Float', $item->price);
$calculatedItem['currency'] = $this->getValueFromStripeObject('currency', 'String', $item->price);
$calculatedItem['amount'] = $subscriptionItem['unit_amount'] * $subscriptionItem['quantity'];
if ($this->getValueFromStripeObject('type', 'String', $item->price) === 'recurring') {
$calculatedItem['frequency_unit'] = $this->getValueFromStripeObject('recurring_interval', 'String', $item->price);
$calculatedItem['frequency_interval'] = $this->getValueFromStripeObject('recurring_interval_count', 'Int', $item->price);
}
if (empty($calculatedItem['frequency_unit'])) {
\Civi::log('stripe')->warning("StripeIPN: {$subscriptionID} customer.subscription.updated:
Non recurring subscription items are not supported");
}
else {
$intervalKey = $calculatedItem['currency'] . '_' . $calculatedItem['frequency_unit'] . '_' . $calculatedItem['frequency_interval'];
if (isset($calculatedItems[$intervalKey])) {
// If we have more than one subscription item with the same currency and frequency add up the amounts and combine.
$calculatedItem['amount'] += ($calculatedItems[$intervalKey]['amount'] ?? 0);
$calculatedItem['subscriptionItem'] = $calculatedItems[$intervalKey]['subscriptionItem'];
}
$calculatedItem['subscriptionItem'][] = $subscriptionItem;
$calculatedItems[$intervalKey] = $calculatedItem;
}
}
return $calculatedItems;
}
}
Civi/Stripe/Webhook/Events.php
+ 2
− 31
View file @ 16f1f92e
......@@ -32,8 +32,7 @@ class Events {
public function __construct(int $paymentProcessorID) {
$this->setPaymentProcessor($paymentProcessorID);
$this->api = new \Civi\Stripe\Api();
$this->api->setPaymentProcessor($paymentProcessorID);
$this->api = new \Civi\Stripe\Api($this->paymentProcessor);
}
/**
......@@ -978,35 +977,7 @@ class Events {
if ($amountHasChanged) {
$objectData = $this->getData()->object;
$calculatedItems = [];
// Recalculate amount and update
foreach ($objectData->items->data as $item) {
$subscriptionItem['subscriptionItemID'] = $this->api->getValueFromStripeObject('id', 'String', $item);
$subscriptionItem['quantity'] = $this->api->getValueFromStripeObject('quantity', 'Int', $item);
$subscriptionItem['unit_amount'] = $this->api->getValueFromStripeObject('unit_amount', 'Float', $item->price);
$calculatedItem['currency'] = $this->api->getValueFromStripeObject('currency', 'String', $item->price);
$calculatedItem['amount'] = $subscriptionItem['unit_amount'] * $subscriptionItem['quantity'];
if ($this->api->getValueFromStripeObject('type', 'String', $item->price) === 'recurring') {
$calculatedItem['frequency_unit'] = $this->api->getValueFromStripeObject('recurring_interval', 'String', $item->price);
$calculatedItem['frequency_interval'] = $this->api->getValueFromStripeObject('recurring_interval_count', 'Int', $item->price);
}
if (empty($calculatedItem['frequency_unit'])) {
\Civi::log('stripe')->warning("StripeIPN: {$objectData->id} customer.subscription.updated:
Non recurring subscription items are not supported");
}
else {
$intervalKey = $calculatedItem['currency'] . '_' . $calculatedItem['frequency_unit'] . '_' . $calculatedItem['frequency_interval'];
if (isset($calculatedItems[$intervalKey])) {
// If we have more than one subscription item with the same currency and frequency add up the amounts and combine.
$calculatedItem['amount'] += ($calculatedItems[$intervalKey]['amount'] ?? 0);
$calculatedItem['subscriptionItem'] = $calculatedItems[$intervalKey]['subscriptionItem'];
}
$calculatedItem['subscriptionItem'][] = $subscriptionItem;
$calculatedItems[$intervalKey] = $calculatedItem;
}
}
$calculatedItems = $this->api->calculateItemsForSubscription($subscriptionID, $objectData);
}
// $calculatedItems now contains array of new prices by key [currency]_[frequency_unit]_[frequency_interval]
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment