Explorer

home / zoteqbgb / public_html / vendor / stripe / stripe-php / lib

Location: /home/zoteqbgb/public_html/vendor/stripe/stripe-php/lib
Root path: /home/zoteqbgb/public_html/config/676626

Editing: Coupon.php

<?php

// File generated from our OpenAPI spec

namespace Stripe;

/**
 * A coupon contains information about a percent-off or amount-off discount you
 * might want to apply to a customer. Coupons may be applied to <a href="https://stripe.com/docs/api#subscriptions">subscriptions</a>, <a href="https://stripe.com/docs/api#invoices">invoices</a>,
 * <a href="https://stripe.com/docs/api/checkout/sessions">checkout sessions</a>, <a href="https://stripe.com/docs/api#quotes">quotes</a>, and more. Coupons do not work with conventional one-off <a href="https://stripe.com/docs/api#create_charge">charges</a> or <a href="https://stripe.com/docs/api/payment_intents">payment intents</a>.
 *
 * @property string $id Unique identifier for the object.
 * @property string $object String representing the object's type. Objects of the same type share the same value.
 * @property null|int $amount_off Amount (in the <code>currency</code> specified) that will be taken off the subtotal of any invoices for this customer.
 * @property null|\Stripe\StripeObject $applies_to
 * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
 * @property null|string $currency If <code>amount_off</code> has been set, the three-letter <a href="https://stripe.com/docs/currencies">ISO code for the currency</a> of the amount to take off.
 * @property null|\Stripe\StripeObject $currency_options Coupons defined in each available currency option. Each key must be a three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a> and a <a href="https://stripe.com/docs/currencies">supported currency</a>.
 * @property string $duration One of <code>forever</code>, <code>once</code>, and <code>repeating</code>. Describes how long a customer who applies this coupon will get the discount.
 * @property null|int $duration_in_months If <code>duration</code> is <code>repeating</code>, the number of months the coupon applies. Null if coupon <code>duration</code> is <code>forever</code> or <code>once</code>.
 * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
 * @property null|int $max_redemptions Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
 * @property null|\Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
 * @property null|string $name Name of the coupon displayed to customers on for instance invoices or receipts.
 * @property null|float $percent_off Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead.
 * @property null|int $redeem_by Date after which the coupon can no longer be redeemed.
 * @property int $times_redeemed Number of times this coupon has been applied to a customer.
 * @property bool $valid Taking account of the above properties, whether this coupon can still be applied to a customer.
 */
class Coupon extends ApiResource
{
    const OBJECT_NAME = 'coupon';

use ApiOperations\All;
    use ApiOperations\Create;
    use ApiOperations\Delete;
    use ApiOperations\Retrieve;
    use ApiOperations\Update;

const DURATION_FOREVER = 'forever';
    const DURATION_ONCE = 'once';
    const DURATION_REPEATING = 'repeating';
}

Directory Contents

Name	Size	Perms	Modified	Actions
Account.php	16,340 bytes	0644	2023-10-16 23:04	âï¸
AccountLink.php	826 bytes	0644	2023-10-16 23:04	âï¸
AccountSession.php	1,824 bytes	0644	2023-10-16 23:04	âï¸
ApiOperations	-	0755	2025-02-20 14:11
ApiRequestor.php	19,052 bytes	0644	2023-10-16 23:04	âï¸
ApiResource.php	3,495 bytes	0644	2023-10-16 23:04	âï¸
ApiResponse.php	712 bytes	0644	2023-10-16 23:04	âï¸
ApplePayDomain.php	1,016 bytes	0644	2023-10-16 23:04	âï¸
ApplicationFee.php	4,397 bytes	0644	2023-10-16 23:04	âï¸
ApplicationFeeRefund.php	2,521 bytes	0644	2023-10-16 23:04	âï¸
Apps	-	0755	2025-02-20 14:11
Balance.php	2,076 bytes	0644	2023-10-16 23:04	âï¸
BalanceTransaction.php	7,031 bytes	0644	2023-10-16 23:04	âï¸
BankAccount.php	7,962 bytes	0644	2023-10-16 23:04	âï¸
BaseStripeClient.php	11,342 bytes	0644	2023-10-16 23:04	âï¸
BaseStripeClientInterface.php	990 bytes	0644	2023-10-16 23:04	âï¸
BillingPortal	-	0755	2025-02-20 14:11
Capability.php	2,995 bytes	0644	2023-10-16 23:04	âï¸
Card.php	8,410 bytes	0644	2023-10-16 23:04	âï¸
CashBalance.php	2,469 bytes	0644	2023-10-16 23:04	âï¸
Charge.php	13,206 bytes	0644	2023-10-16 23:04	âï¸
Checkout	-	0755	2025-02-20 14:11
Collection.php	8,507 bytes	0644	2023-10-16 23:04	âï¸
CountrySpec.php	1,784 bytes	0644	2023-10-16 23:04	âï¸
Coupon.php	3,659 bytes	0644	2023-10-16 23:04	âï¸
CreditNote.php	7,398 bytes	0644	2023-10-16 23:04	âï¸
CreditNoteLineItem.php	2,369 bytes	0644	2023-10-16 23:04	âï¸
Customer.php	18,539 bytes	0644	2023-10-16 23:04	âï¸
CustomerBalanceTransaction.php	5,378 bytes	0644	2023-10-16 23:04	âï¸
CustomerCashBalanceTransaction.php	2,930 bytes	0644	2023-10-16 23:04	âï¸
Discount.php	2,754 bytes	0644	2023-10-16 23:04	âï¸
Dispute.php	5,032 bytes	0644	2023-10-16 23:04	âï¸
EphemeralKey.php	1,552 bytes	0644	2023-10-16 23:04	âï¸
ErrorObject.php	14,665 bytes	0644	2023-10-16 23:04	âï¸
Event.php	34,604 bytes	0644	2023-10-16 23:04	âï¸
Exception	-	0755	2025-02-20 14:11
ExchangeRate.php	1,446 bytes	0644	2023-10-16 23:04	âï¸
File.php	3,824 bytes	0644	2023-10-16 23:04	âï¸
FileLink.php	1,484 bytes	0644	2023-10-16 23:04	âï¸
FinancialConnections	-	0755	2025-02-20 14:11
FundingInstructions.php	1,388 bytes	0644	2023-10-16 23:04	âï¸
HttpClient	-	0755	2025-02-20 14:11
Identity	-	0755	2025-02-20 14:11
Invoice.php	24,082 bytes	0644	2023-10-16 23:04	âï¸
InvoiceItem.php	4,623 bytes	0644	2023-10-16 23:04	âï¸
InvoiceLineItem.php	3,466 bytes	0644	2023-10-16 23:04	âï¸
Issuing	-	0755	2025-02-20 14:12
LineItem.php	1,377 bytes	0644	2023-10-16 23:04	âï¸
LoginLink.php	527 bytes	0644	2023-10-16 23:04	âï¸
Mandate.php	1,400 bytes	0644	2023-10-16 23:04	âï¸
OAuth.php	3,393 bytes	0644	2023-10-16 23:04	âï¸
OAuthErrorObject.php	861 bytes	0644	2023-10-16 23:04	âï¸
PaymentIntent.php	14,885 bytes	0644	2023-10-16 23:04	âï¸
PaymentLink.php	6,244 bytes	0644	2023-10-16 23:04	âï¸
PaymentMethod.php	5,940 bytes	0644	2023-10-16 23:04	âï¸
PaymentMethodConfiguration.php	4,556 bytes	0644	2023-10-16 23:04	âï¸
PaymentMethodDomain.php	2,355 bytes	0644	2023-10-16 23:04	âï¸
Payout.php	7,520 bytes	0644	2023-10-16 23:04	âï¸
Person.php	6,270 bytes	0644	2023-10-16 23:04	âï¸
Plan.php	6,317 bytes	0644	2023-10-16 23:04	âï¸
Price.php	6,463 bytes	0644	2023-10-16 23:04	âï¸
Product.php	4,390 bytes	0644	2023-10-16 23:04	âï¸
PromotionCode.php	2,518 bytes	0644	2023-10-16 23:04	âï¸
Quote.php	9,101 bytes	0644	2023-10-16 23:04	âï¸
Radar	-	0755	2025-02-20 14:12
RecipientTransfer.php	918 bytes	0644	2023-10-16 23:04	âï¸
Refund.php	4,993 bytes	0644	2023-10-16 23:04	âï¸
Reporting	-	0755	2025-02-20 14:12
RequestTelemetry.php	539 bytes	0644	2023-10-16 23:04	âï¸
Review.php	3,764 bytes	0644	2023-10-16 23:04	âï¸
SearchResult.php	6,552 bytes	0644	2023-10-16 23:04	âï¸
Service	-	0755	2025-02-20 14:12
SetupAttempt.php	3,299 bytes	0644	2023-10-16 23:04	âï¸
SetupIntent.php	8,956 bytes	0644	2023-10-16 23:04	âï¸
ShippingRate.php	2,410 bytes	0644	2023-10-16 23:04	âï¸
Sigma	-	0755	2025-02-20 14:12
SingletonApiResource.php	724 bytes	0644	2023-10-16 23:04	âï¸
Source.php	9,288 bytes	0644	2023-10-16 23:04	âï¸
SourceTransaction.php	2,500 bytes	0644	2023-10-16 23:04	âï¸
Stripe.php	7,222 bytes	0644	2023-10-16 23:04	âï¸
StripeClient.php	4,509 bytes	0644	2023-10-16 23:04	âï¸
StripeClientInterface.php	601 bytes	0644	2023-10-16 23:04	âï¸
StripeObject.php	19,318 bytes	0644	2023-10-16 23:04	âï¸
StripeStreamingClientInterface.php	238 bytes	0644	2023-10-16 23:04	âï¸
Subscription.php	14,184 bytes	0644	2023-10-16 23:04	âï¸
SubscriptionItem.php	4,907 bytes	0644	2023-10-16 23:04	âï¸
SubscriptionSchedule.php	4,765 bytes	0644	2023-10-16 23:04	âï¸
Tax	-	0755	2025-02-20 14:12
TaxCode.php	665 bytes	0644	2023-10-16 23:04	âï¸
TaxId.php	6,487 bytes	0644	2023-10-16 23:04	âï¸
TaxRate.php	3,681 bytes	0644	2023-10-16 23:04	âï¸
Terminal	-	0755	2025-02-20 14:12
TestHelpers	-	0755	2025-02-20 14:12
Token.php	3,458 bytes	0644	2023-10-16 23:04	âï¸
Topup.php	3,752 bytes	0644	2023-10-16 23:04	âï¸
Transfer.php	5,891 bytes	0644	2023-10-16 23:04	âï¸
TransferReversal.php	3,364 bytes	0644	2023-10-16 23:04	âï¸
Treasury	-	0755	2025-02-20 14:12
UsageRecord.php	973 bytes	0644	2023-10-16 23:04	âï¸
UsageRecordSummary.php	812 bytes	0644	2023-10-16 23:04	âï¸
Util	-	0755	2025-02-20 14:12
Webhook.php	1,515 bytes	0644	2023-10-16 23:04	âï¸
WebhookEndpoint.php	2,306 bytes	0644	2023-10-16 23:04	âï¸
WebhookSignature.php	4,377 bytes	0644	2023-10-16 23:04	âï¸