Viewing file:  BillingPlans.php (3.96 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
namespace Srmklive\PayPal\Traits\PayPalAPI;
trait BillingPlans
{
/**
* Create a new billing plan.
*
* @param array $data
* @param string $request_id
*
* @throws \Throwable
*
* @return array|\Psr\Http\Message\StreamInterface|string
*
* @see https://developer.paypal.com/docs/api/subscriptions/v1/#plans_create
*/
public function createPlan(array $data, string $request_id)
{
$this->apiEndPoint = 'v1/billing/plans';
$this->options['headers']['PayPal-Request-Id'] = $request_id;
$this->options['json'] = $data;
$this->verb = 'post';
return $this->doPayPalRequest();
}
/**
* List all billing plans.
*
* @param int $page
* @param int $size
* @param bool $totals
*
* @throws \Throwable
*
* @return array|\Psr\Http\Message\StreamInterface|string
*
* @see https://developer.paypal.com/docs/api/subscriptions/v1/#plans_list
*/
public function listPlans(int $page = 1, int $size = 20, bool $totals = true)
{
$totals = ($totals) ? 'true' : 'false';
$this->apiEndPoint = "v1/billing/plans?page={$page}&page_size={$size}&total_required={$totals}";
$this->verb = 'get';
return $this->doPayPalRequest();
}
/**
* Update an existing billing plan.
*
* @param string $plan_id
* @param array $data
*
* @throws \Throwable
*
* @return array|\Psr\Http\Message\StreamInterface|string
*
* @see https://developer.paypal.com/docs/api/invoicing/v2/#invoices_update
*/
public function updatePlan(string $plan_id, array $data)
{
$this->apiEndPoint = "v1/billing/plans/{$plan_id}";
$this->options['json'] = $data;
$this->verb = 'patch';
return $this->doPayPalRequest(false);
}
/**
* Show details for an existing billing plan.
*
* @param string $plan_id
*
* @throws \Throwable
*
* @return array|\Psr\Http\Message\StreamInterface|string
*
* @see https://developer.paypal.com/docs/api/subscriptions/v1/#plans_get
*/
public function showPlanDetails(string $plan_id)
{
$this->apiEndPoint = "v1/billing/plans/{$plan_id}";
$this->verb = 'get';
return $this->doPayPalRequest();
}
/**
* Activate an existing billing plan.
*
* @param string $plan_id
*
* @throws \Throwable
*
* @return array|\Psr\Http\Message\StreamInterface|string
*
* @see https://developer.paypal.com/docs/api/subscriptions/v1/#plans_activate
*/
public function activatePlan(string $plan_id)
{
$this->apiEndPoint = "v1/billing/plans/{$plan_id}/activate";
$this->verb = 'post';
return $this->doPayPalRequest(false);
}
/**
* Deactivate an existing billing plan.
*
* @param string $plan_id
*
* @throws \Throwable
*
* @return array|\Psr\Http\Message\StreamInterface|string
*
* @see https://developer.paypal.com/docs/api/subscriptions/v1/#plans_deactivate
*/
public function deactivatePlan(string $plan_id)
{
$this->apiEndPoint = "v1/billing/plans/{$plan_id}/deactivate";
$this->verb = 'post';
return $this->doPayPalRequest(false);
}
/**
* Update pricing for an existing billing plan.
*
* @param string $plan_id
* @param array $pricing
*
* @throws \Throwable
*
* @return array|\Psr\Http\Message\StreamInterface|string
*
* @see https://developer.paypal.com/docs/api/subscriptions/v1/#plans_update-pricing-schemes
*/
public function updatePlanPricing(string $plan_id, array $pricing)
{
$this->apiEndPoint = "v1/billing/plans/{$plan_id}/update-pricing-schemes";
$this->options['json'] = [
'pricing_schemes' => $pricing,
];
$this->verb = 'post';
return $this->doPayPalRequest(false);
}
}
|