code
stringlengths 15
9.96M
| docstring
stringlengths 1
10.1k
| func_name
stringlengths 1
124
| language
stringclasses 1
value | repo
stringlengths 7
63
| path
stringlengths 6
186
| url
stringlengths 50
236
| license
stringclasses 4
values |
|---|---|---|---|---|---|---|---|
public function hasMultiplePrices()
{
return is_null($this->stripe_price);
} | Determine if the subscription has multiple prices.
@return bool | hasMultiplePrices | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function hasSinglePrice()
{
return ! $this->hasMultiplePrices();
} | Determine if the subscription has a single price.
@return bool | hasSinglePrice | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function findItemOrFail($price)
{
return $this->items()->where('stripe_price', $price)->firstOrFail();
} | Get the subscription item for the given price.
@param string $price
@return \Laravel\Cashier\SubscriptionItem
@throws \Illuminate\Database\Eloquent\ModelNotFoundException | findItemOrFail | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function valid()
{
return $this->active() || $this->onTrial() || $this->onGracePeriod();
} | Determine if the subscription is active, on trial, or within its grace period.
@return bool | valid | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function incomplete()
{
return $this->stripe_status === StripeSubscription::STATUS_INCOMPLETE;
} | Determine if the subscription is incomplete.
@return bool | incomplete | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function scopeIncomplete($query)
{
$query->where('stripe_status', StripeSubscription::STATUS_INCOMPLETE);
} | Filter query by incomplete.
@param \Illuminate\Database\Eloquent\Builder $query
@return void | scopeIncomplete | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function pastDue()
{
return $this->stripe_status === StripeSubscription::STATUS_PAST_DUE;
} | Determine if the subscription is past due.
@return bool | pastDue | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function scopePastDue($query)
{
$query->where('stripe_status', StripeSubscription::STATUS_PAST_DUE);
} | Filter query by past due.
@param \Illuminate\Database\Eloquent\Builder $query
@return void | scopePastDue | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function active()
{
return ! $this->ended() &&
(! Cashier::$deactivateIncomplete || $this->stripe_status !== StripeSubscription::STATUS_INCOMPLETE) &&
$this->stripe_status !== StripeSubscription::STATUS_INCOMPLETE_EXPIRED &&
(! Cashier::$deactivatePastDue || $this->stripe_status !== StripeSubscription::STATUS_PAST_DUE) &&
$this->stripe_status !== StripeSubscription::STATUS_UNPAID;
} | Determine if the subscription is active.
@return bool | active | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function scopeActive($query)
{
$query->where(function ($query) {
$query->whereNull('ends_at')
->orWhere(function ($query) {
$query->onGracePeriod();
});
})->where('stripe_status', '!=', StripeSubscription::STATUS_INCOMPLETE_EXPIRED)
->where('stripe_status', '!=', StripeSubscription::STATUS_UNPAID);
if (Cashier::$deactivatePastDue) {
$query->where('stripe_status', '!=', StripeSubscription::STATUS_PAST_DUE);
}
if (Cashier::$deactivateIncomplete) {
$query->where('stripe_status', '!=', StripeSubscription::STATUS_INCOMPLETE);
}
} | Filter query by active.
@param \Illuminate\Database\Eloquent\Builder $query
@return void | scopeActive | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function syncStripeStatus()
{
$subscription = $this->asStripeSubscription();
$this->stripe_status = $subscription->status;
$this->save();
} | Sync the Stripe status of the subscription.
@return void | syncStripeStatus | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function recurring()
{
return ! $this->onTrial() && ! $this->canceled();
} | Determine if the subscription is recurring and not on trial.
@return bool | recurring | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function scopeRecurring($query)
{
$query->notOnTrial()->notCanceled();
} | Filter query by recurring.
@param \Illuminate\Database\Eloquent\Builder $query
@return void | scopeRecurring | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function canceled()
{
return ! is_null($this->ends_at);
} | Determine if the subscription is no longer active.
@return bool | canceled | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function scopeCanceled($query)
{
$query->whereNotNull('ends_at');
} | Filter query by canceled.
@param \Illuminate\Database\Eloquent\Builder $query
@return void | scopeCanceled | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function scopeNotCanceled($query)
{
$query->whereNull('ends_at');
} | Filter query by not canceled.
@param \Illuminate\Database\Eloquent\Builder $query
@return void | scopeNotCanceled | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function ended()
{
return $this->canceled() && ! $this->onGracePeriod();
} | Determine if the subscription has ended and the grace period has expired.
@return bool | ended | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function scopeEnded($query)
{
$query->canceled()->notOnGracePeriod();
} | Filter query by ended.
@param \Illuminate\Database\Eloquent\Builder $query
@return void | scopeEnded | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function onTrial()
{
return $this->trial_ends_at && $this->trial_ends_at->isFuture();
} | Determine if the subscription is within its trial period.
@return bool | onTrial | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function scopeOnTrial($query)
{
$query->whereNotNull('trial_ends_at')->where('trial_ends_at', '>', Carbon::now());
} | Filter query by on trial.
@param \Illuminate\Database\Eloquent\Builder $query
@return void | scopeOnTrial | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function hasExpiredTrial()
{
return $this->trial_ends_at && $this->trial_ends_at->isPast();
} | Determine if the subscription's trial has expired.
@return bool | hasExpiredTrial | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function scopeExpiredTrial($query)
{
$query->whereNotNull('trial_ends_at')->where('trial_ends_at', '<', Carbon::now());
} | Filter query by expired trial.
@param \Illuminate\Database\Eloquent\Builder $query
@return void | scopeExpiredTrial | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function scopeNotOnTrial($query)
{
$query->whereNull('trial_ends_at')->orWhere('trial_ends_at', '<=', Carbon::now());
} | Filter query by not on trial.
@param \Illuminate\Database\Eloquent\Builder $query
@return void | scopeNotOnTrial | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function onGracePeriod()
{
return $this->ends_at && $this->ends_at->isFuture();
} | Determine if the subscription is within its grace period after cancellation.
@return bool | onGracePeriod | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function scopeOnGracePeriod($query)
{
$query->whereNotNull('ends_at')->where('ends_at', '>', Carbon::now());
} | Filter query by on grace period.
@param \Illuminate\Database\Eloquent\Builder $query
@return void | scopeOnGracePeriod | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function scopeNotOnGracePeriod($query)
{
$query->whereNull('ends_at')->orWhere('ends_at', '<=', Carbon::now());
} | Filter query by not on grace period.
@param \Illuminate\Database\Eloquent\Builder $query
@return void | scopeNotOnGracePeriod | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function incrementQuantity($count = 1, $price = null)
{
$this->guardAgainstIncomplete();
if ($price) {
$this->findItemOrFail($price)
->setPaymentBehavior($this->paymentBehavior)
->setProrationBehavior($this->prorationBehavior)
->incrementQuantity($count);
return $this->refresh();
}
$this->guardAgainstMultiplePrices();
return $this->updateQuantity($this->quantity + $count, $price);
} | Increment the quantity of the subscription.
@param int $count
@param string|null $price
@return $this
@throws \Laravel\Cashier\Exceptions\SubscriptionUpdateFailure | incrementQuantity | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function incrementAndInvoice($count = 1, $price = null)
{
$this->guardAgainstIncomplete();
$this->alwaysInvoice();
return $this->incrementQuantity($count, $price);
} | Increment the quantity of the subscription, and invoice immediately.
@param int $count
@param string|null $price
@return $this
@throws \Laravel\Cashier\Exceptions\IncompletePayment
@throws \Laravel\Cashier\Exceptions\SubscriptionUpdateFailure | incrementAndInvoice | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function decrementQuantity($count = 1, $price = null)
{
$this->guardAgainstIncomplete();
if ($price) {
$this->findItemOrFail($price)
->setPaymentBehavior($this->paymentBehavior)
->setProrationBehavior($this->prorationBehavior)
->decrementQuantity($count);
return $this->refresh();
}
$this->guardAgainstMultiplePrices();
return $this->updateQuantity(max(1, $this->quantity - $count), $price);
} | Decrement the quantity of the subscription.
@param int $count
@param string|null $price
@return $this
@throws \Laravel\Cashier\Exceptions\SubscriptionUpdateFailure | decrementQuantity | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function updateQuantity($quantity, $price = null)
{
$this->guardAgainstIncomplete();
if ($price) {
$this->findItemOrFail($price)
->setPaymentBehavior($this->paymentBehavior)
->setProrationBehavior($this->prorationBehavior)
->updateQuantity($quantity);
return $this->refresh();
}
$this->guardAgainstMultiplePrices();
$stripeSubscription = $this->updateStripeSubscription([
'payment_behavior' => $this->paymentBehavior(),
'proration_behavior' => $this->prorateBehavior(),
'quantity' => $quantity,
'expand' => ['latest_invoice.payment_intent'],
]);
$this->fill([
'stripe_status' => $stripeSubscription->status,
'quantity' => $stripeSubscription->quantity,
])->save();
$this->handlePaymentFailure($this);
return $this;
} | Update the quantity of the subscription.
@param int $quantity
@param string|null $price
@return $this
@throws \Laravel\Cashier\Exceptions\SubscriptionUpdateFailure | updateQuantity | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function reportUsage($quantity = 1, $timestamp = null, $price = null)
{
if (! $price) {
$this->guardAgainstMultiplePrices();
}
return $this->findItemOrFail($price ?? $this->stripe_price)->reportUsage($quantity, $timestamp);
} | Report usage for a metered product.
@param int $quantity
@param \DateTimeInterface|int|null $timestamp
@param string|null $price
@return \Stripe\UsageRecord | reportUsage | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function reportUsageFor($price, $quantity = 1, $timestamp = null)
{
return $this->reportUsage($quantity, $timestamp, $price);
} | Report usage for specific price of a metered product.
@param string $price
@param int $quantity
@param \DateTimeInterface|int|null $timestamp
@return \Stripe\UsageRecord | reportUsageFor | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function usageRecords(array $options = [], $price = null)
{
if (! $price) {
$this->guardAgainstMultiplePrices();
}
return $this->findItemOrFail($price ?? $this->stripe_price)->usageRecords($options);
} | Get the usage records for a metered product.
@param array $options
@param string|null $price
@return \Illuminate\Support\Collection | usageRecords | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function usageRecordsFor($price, array $options = [])
{
return $this->usageRecords($options, $price);
} | Get the usage records for a specific price of a metered product.
@param string $price
@param array $options
@return \Illuminate\Support\Collection | usageRecordsFor | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function anchorBillingCycleOn($date = 'now')
{
if ($date instanceof DateTimeInterface) {
$date = $date->getTimestamp();
}
$this->billingCycleAnchor = $date;
return $this;
} | Change the billing cycle anchor on a price change.
@param \DateTimeInterface|int|string $date
@return $this | anchorBillingCycleOn | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function skipTrial()
{
$this->trial_ends_at = null;
return $this;
} | Force the trial to end immediately.
This method must be combined with swap, resume, etc.
@return $this | skipTrial | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function endTrial()
{
if (is_null($this->trial_ends_at)) {
return $this;
}
$this->updateStripeSubscription([
'trial_end' => 'now',
'proration_behavior' => $this->prorateBehavior(),
]);
$this->trial_ends_at = null;
$this->save();
return $this;
} | Force the subscription's trial to end immediately.
@return $this | endTrial | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function extendTrial(CarbonInterface $date)
{
if (! $date->isFuture()) {
throw new InvalidArgumentException("Extending a subscription's trial requires a date in the future.");
}
$this->updateStripeSubscription([
'trial_end' => $date->getTimestamp(),
'proration_behavior' => $this->prorateBehavior(),
]);
$this->trial_ends_at = $date;
$this->save();
return $this;
} | Extend an existing subscription's trial period.
@param \Carbon\CarbonInterface $date
@return $this | extendTrial | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function swapAndInvoice($prices, array $options = [])
{
$this->alwaysInvoice();
return $this->swap($prices, $options);
} | Swap the subscription to new Stripe prices, and invoice immediately.
@param string|array $prices
@param array $options
@return $this
@throws \Laravel\Cashier\Exceptions\IncompletePayment
@throws \Laravel\Cashier\Exceptions\SubscriptionUpdateFailure | swapAndInvoice | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
protected function getSwapOptions(Collection $items, array $options = [])
{
$payload = array_filter([
'items' => $items->values()->all(),
'payment_behavior' => $this->paymentBehavior(),
'promotion_code' => $this->promotionCodeId,
'proration_behavior' => $this->prorateBehavior(),
'expand' => ['latest_invoice.payment_intent'],
]);
if ($payload['payment_behavior'] !== StripeSubscription::PAYMENT_BEHAVIOR_PENDING_IF_INCOMPLETE) {
$payload['cancel_at_period_end'] = false;
}
$payload = array_merge($payload, $options);
if (! is_null($this->billingCycleAnchor)) {
$payload['billing_cycle_anchor'] = $this->billingCycleAnchor;
}
$payload['trial_end'] = $this->onTrial()
? $this->trial_ends_at->getTimestamp()
: 'now';
return $payload;
} | Get the options array for a swap operation.
@param \Illuminate\Support\Collection $items
@param array $options
@return array | getSwapOptions | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function addPrice($price, $quantity = 1, array $options = [])
{
$this->guardAgainstIncomplete();
if ($this->items->contains('stripe_price', $price)) {
throw SubscriptionUpdateFailure::duplicatePrice($this, $price);
}
$stripeSubscriptionItem = $this->owner->stripe()->subscriptionItems
->create(array_filter(array_merge([
'subscription' => $this->stripe_id,
'price' => $price,
'quantity' => $quantity,
'tax_rates' => $this->getPriceTaxRatesForPayload($price),
'payment_behavior' => $this->paymentBehavior(),
'proration_behavior' => $this->prorateBehavior(),
], $options)));
$this->items()->create([
'stripe_id' => $stripeSubscriptionItem->id,
'stripe_product' => $stripeSubscriptionItem->price->product,
'stripe_price' => $stripeSubscriptionItem->price->id,
'quantity' => $stripeSubscriptionItem->quantity ?? null,
]);
$this->unsetRelation('items');
$stripeSubscription = $this->asStripeSubscription();
if ($this->hasSinglePrice()) {
$this->fill([
'stripe_price' => null,
'quantity' => null,
]);
}
$this->fill([
'stripe_status' => $stripeSubscription->status,
])->save();
$this->handlePaymentFailure($this);
return $this;
} | Add a new Stripe price to the subscription.
@param string $price
@param int|null $quantity
@param array $options
@return $this
@throws \Laravel\Cashier\Exceptions\SubscriptionUpdateFailure | addPrice | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function addPriceAndInvoice($price, $quantity = 1, array $options = [])
{
$this->alwaysInvoice();
return $this->addPrice($price, $quantity, $options);
} | Add a new Stripe price to the subscription, and invoice immediately.
@param string $price
@param int $quantity
@param array $options
@return $this
@throws \Laravel\Cashier\Exceptions\IncompletePayment
@throws \Laravel\Cashier\Exceptions\SubscriptionUpdateFailure | addPriceAndInvoice | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function addMeteredPrice($price, array $options = [])
{
return $this->addPrice($price, null, $options);
} | Add a new Stripe metered price to the subscription.
@param string $price
@param array $options
@return $this
@throws \Laravel\Cashier\Exceptions\SubscriptionUpdateFailure | addMeteredPrice | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function addMeteredPriceAndInvoice($price, array $options = [])
{
return $this->addPriceAndInvoice($price, null, $options);
} | Add a new Stripe metered price to the subscription, and invoice immediately.
@param string $price
@param array $options
@return $this
@throws \Laravel\Cashier\Exceptions\IncompletePayment
@throws \Laravel\Cashier\Exceptions\SubscriptionUpdateFailure | addMeteredPriceAndInvoice | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function removePrice($price)
{
if ($this->hasSinglePrice()) {
throw SubscriptionUpdateFailure::cannotDeleteLastPrice($this);
}
$stripeItem = $this->findItemOrFail($price)->asStripeSubscriptionItem();
$stripeItem->delete(array_filter([
'clear_usage' => $stripeItem->price->recurring->usage_type === 'metered' ? true : null,
'proration_behavior' => $this->prorateBehavior(),
]));
$this->items()->where('stripe_price', $price)->delete();
$this->unsetRelation('items');
if ($this->items()->count() < 2) {
$item = $this->items()->first();
$this->fill([
'stripe_price' => $item->stripe_price,
'quantity' => $item->quantity,
])->save();
}
return $this;
} | Remove a Stripe price from the subscription.
@param string $price
@return $this
@throws \Laravel\Cashier\Exceptions\SubscriptionUpdateFailure | removePrice | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function cancel()
{
$stripeSubscription = $this->updateStripeSubscription([
'cancel_at_period_end' => true,
]);
$this->stripe_status = $stripeSubscription->status;
// If the user was on trial, we will set the grace period to end when the trial
// would have ended. Otherwise, we'll retrieve the end of the billing period
// period and make that the end of the grace period for this current user.
if ($this->onTrial()) {
$this->ends_at = $this->trial_ends_at;
} else {
$this->ends_at = Carbon::createFromTimestamp(
$stripeSubscription->current_period_end
);
}
$this->save();
return $this;
} | Cancel the subscription at the end of the billing period.
@return $this | cancel | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function cancelAt($endsAt)
{
if ($endsAt instanceof DateTimeInterface) {
$endsAt = $endsAt->getTimestamp();
}
$stripeSubscription = $this->updateStripeSubscription([
'cancel_at' => $endsAt,
'proration_behavior' => $this->prorateBehavior(),
]);
$this->stripe_status = $stripeSubscription->status;
$this->ends_at = Carbon::createFromTimestamp($stripeSubscription->cancel_at);
$this->save();
return $this;
} | Cancel the subscription at a specific moment in time.
@param \DateTimeInterface|int $endsAt
@return $this | cancelAt | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function cancelNow()
{
$this->owner->stripe()->subscriptions->cancel($this->stripe_id, [
'prorate' => $this->prorateBehavior() === 'create_prorations',
]);
$this->markAsCanceled();
return $this;
} | Cancel the subscription immediately without invoicing.
@return $this | cancelNow | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function cancelNowAndInvoice()
{
$this->owner->stripe()->subscriptions->cancel($this->stripe_id, [
'invoice_now' => true,
'prorate' => $this->prorateBehavior() === 'create_prorations',
]);
$this->markAsCanceled();
return $this;
} | Cancel the subscription immediately and invoice.
@return $this | cancelNowAndInvoice | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function markAsCanceled()
{
$this->fill([
'stripe_status' => StripeSubscription::STATUS_CANCELED,
'ends_at' => Carbon::now(),
])->save();
} | Mark the subscription as canceled.
@return void
@internal | markAsCanceled | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function resume()
{
if (! $this->onGracePeriod()) {
throw new LogicException('Unable to resume subscription that is not within grace period.');
}
$stripeSubscription = $this->updateStripeSubscription([
'cancel_at_period_end' => false,
'trial_end' => $this->onTrial() ? $this->trial_ends_at->getTimestamp() : 'now',
]);
// Finally, we will remove the ending timestamp from the user's record in the
// local database to indicate that the subscription is active again and is
// no longer "canceled". Then we shall save this record in the database.
$this->fill([
'stripe_status' => $stripeSubscription->status,
'ends_at' => null,
])->save();
return $this;
} | Resume the canceled subscription.
@return $this
@throws \LogicException | resume | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function pending()
{
return ! is_null($this->asStripeSubscription()->pending_update);
} | Determine if the subscription has pending updates.
@return bool | pending | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function invoice(array $options = [])
{
try {
return $this->user->invoice(array_merge($options, ['subscription' => $this->stripe_id]));
} catch (IncompletePayment $exception) {
// Set the new Stripe subscription status immediately when payment fails...
$this->fill([
'stripe_status' => $exception->payment->invoice->subscription->status,
])->save();
throw $exception;
}
} | Invoice the subscription outside of the regular billing cycle.
@param array $options
@return \Laravel\Cashier\Invoice
@throws \Laravel\Cashier\Exceptions\IncompletePayment | invoice | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function latestInvoice(array $expand = [])
{
$stripeSubscription = $this->asStripeSubscription(['latest_invoice', ...$expand]);
if ($stripeSubscription->latest_invoice) {
return new Invoice($this->owner, $stripeSubscription->latest_invoice);
}
} | Get the latest invoice for the subscription.
@return \Laravel\Cashier\Invoice|null | latestInvoice | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function upcomingInvoice(array $options = [])
{
if ($this->canceled()) {
return null;
}
return $this->owner->upcomingInvoice(array_merge([
'subscription' => $this->stripe_id,
], $options));
} | Fetches upcoming invoice for this subscription.
@param array $options
@return \Laravel\Cashier\Invoice|null | upcomingInvoice | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function previewInvoice($prices, array $options = [])
{
if (empty($prices = (array) $prices)) {
throw new InvalidArgumentException('Please provide at least one price when swapping.');
}
$this->guardAgainstIncomplete();
$items = $this->mergeItemsThatShouldBeDeletedDuringSwap(
$this->parseSwapPrices($prices)
);
$swapOptions = Collection::make($this->getSwapOptions($items))
->only([
'billing_cycle_anchor',
'cancel_at_period_end',
'items',
'proration_behavior',
'trial_end',
])
->mapWithKeys(function ($value, $key) {
return ["subscription_$key" => $value];
})
->merge($options)
->all();
return $this->upcomingInvoice($swapOptions);
} | Preview the upcoming invoice with new Stripe prices.
@param string|array $prices
@param array $options
@return \Laravel\Cashier\Invoice|null | previewInvoice | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function invoices($includePending = false, $parameters = [])
{
return $this->owner->invoices(
$includePending, array_merge($parameters, ['subscription' => $this->stripe_id])
);
} | Get a collection of the subscription's invoices.
@param bool $includePending
@param array $parameters
@return \Illuminate\Support\Collection|\Laravel\Cashier\Invoice[] | invoices | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function invoicesIncludingPending(array $parameters = [])
{
return $this->invoices(true, $parameters);
} | Get an array of the subscription's invoices, including pending invoices.
@param array $parameters
@return \Illuminate\Support\Collection|\Laravel\Cashier\Invoice[] | invoicesIncludingPending | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function getPriceTaxRatesForPayload($price)
{
if ($taxRates = $this->owner->priceTaxRates()) {
return $taxRates[$price] ?? null;
}
} | Get the price tax rates for the Stripe payload.
@param string $price
@return array|null | getPriceTaxRatesForPayload | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function hasIncompletePayment()
{
return $this->pastDue() || $this->incomplete();
} | Determine if the subscription has an incomplete payment.
@return bool | hasIncompletePayment | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function latestPayment()
{
$subscription = $this->asStripeSubscription(['latest_invoice.payment_intent']);
if ($invoice = $subscription->latest_invoice) {
return $invoice->payment_intent
? new Payment($invoice->payment_intent)
: null;
}
} | Get the latest payment for a Subscription.
@return \Laravel\Cashier\Payment|null | latestPayment | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function discount()
{
$subscription = $this->asStripeSubscription(['discount.promotion_code']);
return $subscription->discount
? new Discount($subscription->discount)
: null;
} | The discount that applies to the subscription, if applicable.
@return \Laravel\Cashier\Discount|null | discount | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function applyCoupon($coupon)
{
$this->updateStripeSubscription([
'coupon' => $coupon,
]);
} | Apply a coupon to the subscription.
@param string $coupon
@return void | applyCoupon | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function applyPromotionCode($promotionCodeId)
{
$this->updateStripeSubscription([
'promotion_code' => $promotionCodeId,
]);
} | Apply a promotion code to the subscription.
@param string $promotionCodeId
@return void | applyPromotionCode | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function guardAgainstIncomplete()
{
if ($this->incomplete()) {
throw SubscriptionUpdateFailure::incompleteSubscription($this);
}
} | Make sure a subscription is not incomplete when performing changes.
@return void
@throws \Laravel\Cashier\Exceptions\SubscriptionUpdateFailure | guardAgainstIncomplete | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function guardAgainstMultiplePrices()
{
if ($this->hasMultiplePrices()) {
throw new InvalidArgumentException(
'This method requires a price argument since the subscription has multiple prices.'
);
}
} | Make sure a price argument is provided when the subscription is a subscription with multiple prices.
@return void
@throws \InvalidArgumentException | guardAgainstMultiplePrices | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function updateStripeSubscription(array $options = [])
{
return $this->owner->stripe()->subscriptions->update(
$this->stripe_id, $options
);
} | Update the underlying Stripe subscription information for the model.
@param array $options
@return \Stripe\Subscription | updateStripeSubscription | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function asStripeSubscription(array $expand = [])
{
return $this->owner->stripe()->subscriptions->retrieve(
$this->stripe_id, ['expand' => $expand]
);
} | Get the subscription as a Stripe subscription object.
@param array $expand
@return \Stripe\Subscription | asStripeSubscription | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
protected static function newFactory()
{
return SubscriptionFactory::new();
} | Create a new factory instance for the model.
@return \Illuminate\Database\Eloquent\Factories\Factory | newFactory | php | laravel/cashier-stripe | src/Subscription.php | https://github.com/laravel/cashier-stripe/blob/master/src/Subscription.php | MIT |
public function __construct(StripeCoupon $coupon)
{
$this->coupon = $coupon;
} | Create a new Coupon instance.
@param \Stripe\Coupon $coupon
@return void | __construct | php | laravel/cashier-stripe | src/Coupon.php | https://github.com/laravel/cashier-stripe/blob/master/src/Coupon.php | MIT |
public function name()
{
return $this->coupon->name ?: $this->coupon->id;
} | Get the readable name for the Coupon.
@return string | name | php | laravel/cashier-stripe | src/Coupon.php | https://github.com/laravel/cashier-stripe/blob/master/src/Coupon.php | MIT |
public function isPercentage()
{
return ! is_null($this->coupon->percent_off);
} | Determine if the coupon is a percentage.
@return bool | isPercentage | php | laravel/cashier-stripe | src/Coupon.php | https://github.com/laravel/cashier-stripe/blob/master/src/Coupon.php | MIT |
public function percentOff()
{
return $this->coupon->percent_off;
} | Get the discount percentage for the invoice.
@return float|null | percentOff | php | laravel/cashier-stripe | src/Coupon.php | https://github.com/laravel/cashier-stripe/blob/master/src/Coupon.php | MIT |
public function amountOff()
{
if (! is_null($this->coupon->amount_off)) {
return $this->formatAmount($this->rawAmountOff());
}
} | Get the amount off for the coupon.
@return string|null | amountOff | php | laravel/cashier-stripe | src/Coupon.php | https://github.com/laravel/cashier-stripe/blob/master/src/Coupon.php | MIT |
public function rawAmountOff()
{
return $this->coupon->amount_off;
} | Get the raw amount off for the coupon.
@return int|null | rawAmountOff | php | laravel/cashier-stripe | src/Coupon.php | https://github.com/laravel/cashier-stripe/blob/master/src/Coupon.php | MIT |
protected function formatAmount($amount)
{
return Cashier::formatAmount($amount, $this->coupon->currency);
} | Format the given amount into a displayable currency.
@param int $amount
@return string | formatAmount | php | laravel/cashier-stripe | src/Coupon.php | https://github.com/laravel/cashier-stripe/blob/master/src/Coupon.php | MIT |
public function asStripeCoupon()
{
return $this->coupon;
} | Get the Stripe Coupon instance.
@return \Stripe\Coupon | asStripeCoupon | php | laravel/cashier-stripe | src/Coupon.php | https://github.com/laravel/cashier-stripe/blob/master/src/Coupon.php | MIT |
public function toArray()
{
return $this->asStripeCoupon()->toArray();
} | Get the instance as an array.
@return array | toArray | php | laravel/cashier-stripe | src/Coupon.php | https://github.com/laravel/cashier-stripe/blob/master/src/Coupon.php | MIT |
public function toJson($options = 0)
{
return json_encode($this->jsonSerialize(), $options);
} | Convert the object to its JSON representation.
@param int $options
@return string | toJson | php | laravel/cashier-stripe | src/Coupon.php | https://github.com/laravel/cashier-stripe/blob/master/src/Coupon.php | MIT |
public function jsonSerialize()
{
return $this->toArray();
} | [\ReturnTypeWillChange] | jsonSerialize | php | laravel/cashier-stripe | src/Coupon.php | https://github.com/laravel/cashier-stripe/blob/master/src/Coupon.php | MIT |
public function __get($key)
{
return $this->coupon->{$key};
} | Dynamically get values from the Stripe object.
@param string $key
@return mixed | __get | php | laravel/cashier-stripe | src/Coupon.php | https://github.com/laravel/cashier-stripe/blob/master/src/Coupon.php | MIT |
public function __construct(StripeDiscount $discount)
{
$this->discount = $discount;
} | Create a new Discount instance.
@param \Stripe\Discount $discount
@return void | __construct | php | laravel/cashier-stripe | src/Discount.php | https://github.com/laravel/cashier-stripe/blob/master/src/Discount.php | MIT |
public function coupon()
{
return new Coupon($this->discount->coupon);
} | Get the coupon applied to the discount.
@return \Laravel\Cashier\Coupon | coupon | php | laravel/cashier-stripe | src/Discount.php | https://github.com/laravel/cashier-stripe/blob/master/src/Discount.php | MIT |
public function promotionCode()
{
if (! is_null($this->discount->promotion_code) && ! is_string($this->discount->promotion_code)) {
return new PromotionCode($this->discount->promotion_code);
}
} | Get the promotion code applied to create this discount.
@return \Laravel\Cashier\PromotionCode|null | promotionCode | php | laravel/cashier-stripe | src/Discount.php | https://github.com/laravel/cashier-stripe/blob/master/src/Discount.php | MIT |
public function start()
{
return Carbon::createFromTimestamp($this->discount->start);
} | Get the date that the coupon was applied.
@return \Carbon\Carbon | start | php | laravel/cashier-stripe | src/Discount.php | https://github.com/laravel/cashier-stripe/blob/master/src/Discount.php | MIT |
public function end()
{
if (! is_null($this->discount->end)) {
return Carbon::createFromTimestamp($this->discount->end);
}
} | Get the date that this discount will end.
@return \Carbon\Carbon|null | end | php | laravel/cashier-stripe | src/Discount.php | https://github.com/laravel/cashier-stripe/blob/master/src/Discount.php | MIT |
public function asStripeDiscount()
{
return $this->discount;
} | Get the Stripe Discount instance.
@return \Stripe\Discount | asStripeDiscount | php | laravel/cashier-stripe | src/Discount.php | https://github.com/laravel/cashier-stripe/blob/master/src/Discount.php | MIT |
public function toArray()
{
return $this->asStripeDiscount()->toArray();
} | Get the instance as an array.
@return array | toArray | php | laravel/cashier-stripe | src/Discount.php | https://github.com/laravel/cashier-stripe/blob/master/src/Discount.php | MIT |
public function toJson($options = 0)
{
return json_encode($this->jsonSerialize(), $options);
} | Convert the object to its JSON representation.
@param int $options
@return string | toJson | php | laravel/cashier-stripe | src/Discount.php | https://github.com/laravel/cashier-stripe/blob/master/src/Discount.php | MIT |
public function jsonSerialize()
{
return $this->toArray();
} | [\ReturnTypeWillChange] | jsonSerialize | php | laravel/cashier-stripe | src/Discount.php | https://github.com/laravel/cashier-stripe/blob/master/src/Discount.php | MIT |
public function __get($key)
{
return $this->discount->{$key};
} | Dynamically get values from the Stripe object.
@param string $key
@return mixed | __get | php | laravel/cashier-stripe | src/Discount.php | https://github.com/laravel/cashier-stripe/blob/master/src/Discount.php | MIT |
public static function findBillable($stripeId)
{
$stripeId = $stripeId instanceof StripeCustomer ? $stripeId->id : $stripeId;
$model = static::$customerModel;
$builder = in_array(SoftDeletes::class, class_uses_recursive($model))
? $model::withTrashed()
: new $model;
return $stripeId ? $builder->where('stripe_id', $stripeId)->first() : null;
} | Get the customer instance by its Stripe ID.
@param \Stripe\Customer|string|null $stripeId
@return \Laravel\Cashier\Billable|null | findBillable | php | laravel/cashier-stripe | src/Cashier.php | https://github.com/laravel/cashier-stripe/blob/master/src/Cashier.php | MIT |
public static function stripe(array $options = [])
{
$config = array_merge([
'api_key' => $options['api_key'] ?? config('cashier.secret'),
'stripe_version' => static::STRIPE_VERSION,
'api_base' => static::$apiBaseUrl,
], $options);
return app(StripeClient::class, ['config' => $config]);
} | Get the Stripe SDK client.
@param array $options
@return \Stripe\StripeClient | stripe | php | laravel/cashier-stripe | src/Cashier.php | https://github.com/laravel/cashier-stripe/blob/master/src/Cashier.php | MIT |
public static function formatCurrencyUsing(callable $callback)
{
static::$formatCurrencyUsing = $callback;
} | Set the custom currency formatter.
@param callable $callback
@return void | formatCurrencyUsing | php | laravel/cashier-stripe | src/Cashier.php | https://github.com/laravel/cashier-stripe/blob/master/src/Cashier.php | MIT |
public static function formatAmount($amount, $currency = null, $locale = null, array $options = [])
{
if (static::$formatCurrencyUsing) {
return call_user_func(static::$formatCurrencyUsing, $amount, $currency, $locale, $options);
}
$money = new Money($amount, new Currency(strtoupper($currency ?? config('cashier.currency'))));
$locale = $locale ?? config('cashier.currency_locale');
$numberFormatter = new NumberFormatter($locale, NumberFormatter::CURRENCY);
if (isset($options['min_fraction_digits'])) {
$numberFormatter->setAttribute(NumberFormatter::MIN_FRACTION_DIGITS, $options['min_fraction_digits']);
}
$moneyFormatter = new IntlMoneyFormatter($numberFormatter, new ISOCurrencies());
return $moneyFormatter->format($money);
} | Format the given amount into a displayable currency.
@param int $amount
@param string|null $currency
@param string|null $locale
@param array $options
@return string | formatAmount | php | laravel/cashier-stripe | src/Cashier.php | https://github.com/laravel/cashier-stripe/blob/master/src/Cashier.php | MIT |
public static function ignoreRoutes()
{
static::$registersRoutes = false;
return new static;
} | Configure Cashier to not register its routes.
@return static | ignoreRoutes | php | laravel/cashier-stripe | src/Cashier.php | https://github.com/laravel/cashier-stripe/blob/master/src/Cashier.php | MIT |
public static function keepPastDueSubscriptionsActive()
{
static::$deactivatePastDue = false;
return new static;
} | Configure Cashier to maintain past due subscriptions as active.
@return static | keepPastDueSubscriptionsActive | php | laravel/cashier-stripe | src/Cashier.php | https://github.com/laravel/cashier-stripe/blob/master/src/Cashier.php | MIT |
public static function keepIncompleteSubscriptionsActive()
{
static::$deactivateIncomplete = false;
return new static;
} | Configure Cashier to maintain incomplete subscriptions as active.
@return static | keepIncompleteSubscriptionsActive | php | laravel/cashier-stripe | src/Cashier.php | https://github.com/laravel/cashier-stripe/blob/master/src/Cashier.php | MIT |
public static function calculateTaxes()
{
static::$calculatesTaxes = true;
return new static;
} | Configure Cashier to automatically calculate taxes using Stripe Tax.
@return static | calculateTaxes | php | laravel/cashier-stripe | src/Cashier.php | https://github.com/laravel/cashier-stripe/blob/master/src/Cashier.php | MIT |
public static function useCustomerModel($customerModel)
{
static::$customerModel = $customerModel;
} | Set the customer model class name.
@param string $customerModel
@return void | useCustomerModel | php | laravel/cashier-stripe | src/Cashier.php | https://github.com/laravel/cashier-stripe/blob/master/src/Cashier.php | MIT |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.