ApiOperations
1 year ago
Apps
1 year ago
Billing
1 year ago
BillingPortal
1 year ago
Checkout
1 year ago
Climate
1 year ago
Entitlements
1 year ago
EventData
1 year ago
Events
1 year ago
Exception
1 year ago
FinancialConnections
1 year ago
Forwarding
1 year ago
HttpClient
1 year ago
Identity
1 year ago
Issuing
1 year ago
Radar
1 year ago
Reporting
1 year ago
Service
1 year ago
Sigma
1 year ago
Tax
1 year ago
Terminal
1 year ago
TestHelpers
1 year ago
Treasury
1 year ago
Util
1 year ago
V2
1 year ago
Account.php
1 year ago
AccountLink.php
1 year ago
AccountSession.php
1 year ago
ApiRequestor.php
1 year ago
ApiResource.php
2 years ago
ApiResponse.php
2 years ago
ApplePayDomain.php
1 year ago
Application.php
2 years ago
ApplicationFee.php
1 year ago
ApplicationFeeRefund.php
2 years ago
Balance.php
1 year ago
BalanceTransaction.php
1 year ago
BankAccount.php
1 year ago
BaseStripeClient.php
1 year ago
BaseStripeClientInterface.php
1 year ago
Capability.php
1 year ago
Card.php
1 year ago
CashBalance.php
2 years ago
Charge.php
1 year ago
Collection.php
1 year ago
ConfirmationToken.php
1 year ago
ConnectCollectionTransfer.php
2 years ago
CountrySpec.php
1 year ago
Coupon.php
1 year ago
CreditNote.php
1 year ago
CreditNoteLineItem.php
1 year ago
Customer.php
1 year ago
CustomerBalanceTransaction.php
2 years ago
CustomerCashBalanceTransaction.php
2 years ago
CustomerSession.php
1 year ago
Discount.php
1 year ago
Dispute.php
1 year ago
EphemeralKey.php
1 year ago
ErrorObject.php
1 year ago
Event.php
1 year ago
ExchangeRate.php
1 year ago
File.php
1 year ago
FileLink.php
1 year ago
FundingInstructions.php
2 years ago
Invoice.php
1 year ago
InvoiceItem.php
1 year ago
InvoiceLineItem.php
1 year ago
InvoiceRenderingTemplate.php
1 year ago
LineItem.php
1 year ago
LoginLink.php
1 year ago
Mandate.php
1 year ago
OAuth.php
2 years ago
OAuthErrorObject.php
1 year ago
PaymentIntent.php
1 year ago
PaymentLink.php
1 year ago
PaymentMethod.php
1 year ago
PaymentMethodConfiguration.php
1 year ago
PaymentMethodDomain.php
1 year ago
Payout.php
1 year ago
Person.php
1 year ago
Plan.php
1 year ago
Price.php
1 year ago
Product.php
1 year ago
ProductFeature.php
1 year ago
PromotionCode.php
1 year ago
Quote.php
1 year ago
Reason.php
1 year ago
RecipientTransfer.php
2 years ago
Refund.php
1 year ago
RelatedObject.php
1 year ago
RequestTelemetry.php
2 years ago
ReserveTransaction.php
2 years ago
Review.php
1 year ago
SearchResult.php
1 year ago
SetupAttempt.php
1 year ago
SetupIntent.php
1 year ago
ShippingRate.php
1 year ago
SingletonApiResource.php
2 years ago
Source.php
1 year ago
SourceMandateNotification.php
2 years ago
SourceTransaction.php
2 years ago
Stripe.php
1 year ago
StripeClient.php
1 year ago
StripeClientInterface.php
2 years ago
StripeObject.php
1 year ago
StripeStreamingClientInterface.php
2 years ago
Subscription.php
1 year ago
SubscriptionItem.php
1 year ago
SubscriptionSchedule.php
1 year ago
TaxCode.php
1 year ago
TaxDeductedAtSource.php
2 years ago
TaxId.php
1 year ago
TaxRate.php
1 year ago
ThinEvent.php
1 year ago
Token.php
1 year ago
Topup.php
1 year ago
Transfer.php
1 year ago
TransferReversal.php
1 year ago
UsageRecord.php
1 year ago
UsageRecordSummary.php
1 year ago
Webhook.php
1 year ago
WebhookEndpoint.php
1 year ago
WebhookSignature.php
2 years ago
ShippingRate.php
103 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | namespace WPForms\Vendor\Stripe; |
| 5 | |
| 6 | /** |
| 7 | * Shipping rates describe the price of shipping presented to your customers and |
| 8 | * applied to a purchase. For more information, see <a href="https://stripe.com/docs/payments/during-payment/charge-shipping">Charge for shipping</a>. |
| 9 | * |
| 10 | * @property string $id Unique identifier for the object. |
| 11 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 12 | * @property bool $active Whether the shipping rate can be used for new purchases. Defaults to <code>true</code>. |
| 13 | * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 14 | * @property null|\Stripe\StripeObject $delivery_estimate The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions. |
| 15 | * @property null|string $display_name The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. |
| 16 | * @property null|\Stripe\StripeObject $fixed_amount |
| 17 | * @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. |
| 18 | * @property \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. |
| 19 | * @property null|string $tax_behavior Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of <code>inclusive</code>, <code>exclusive</code>, or <code>unspecified</code>. |
| 20 | * @property null|string|\Stripe\TaxCode $tax_code A <a href="https://stripe.com/docs/tax/tax-categories">tax code</a> ID. The Shipping tax code is <code>txcd_92010001</code>. |
| 21 | * @property string $type The type of calculation to use on the shipping rate. |
| 22 | */ |
| 23 | class ShippingRate extends ApiResource |
| 24 | { |
| 25 | const OBJECT_NAME = 'shipping_rate'; |
| 26 | use ApiOperations\Update; |
| 27 | const TAX_BEHAVIOR_EXCLUSIVE = 'exclusive'; |
| 28 | const TAX_BEHAVIOR_INCLUSIVE = 'inclusive'; |
| 29 | const TAX_BEHAVIOR_UNSPECIFIED = 'unspecified'; |
| 30 | const TYPE_FIXED_AMOUNT = 'fixed_amount'; |
| 31 | /** |
| 32 | * Creates a new shipping rate object. |
| 33 | * |
| 34 | * @param null|array $params |
| 35 | * @param null|array|string $options |
| 36 | * |
| 37 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 38 | * |
| 39 | * @return \Stripe\ShippingRate the created resource |
| 40 | */ |
| 41 | public static function create($params = null, $options = null) |
| 42 | { |
| 43 | self::_validateParams($params); |
| 44 | $url = static::classUrl(); |
| 45 | list($response, $opts) = static::_staticRequest('post', $url, $params, $options); |
| 46 | $obj = \WPForms\Vendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts); |
| 47 | $obj->setLastResponse($response); |
| 48 | return $obj; |
| 49 | } |
| 50 | /** |
| 51 | * Returns a list of your shipping rates. |
| 52 | * |
| 53 | * @param null|array $params |
| 54 | * @param null|array|string $opts |
| 55 | * |
| 56 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 57 | * |
| 58 | * @return \Stripe\Collection<\Stripe\ShippingRate> of ApiResources |
| 59 | */ |
| 60 | public static function all($params = null, $opts = null) |
| 61 | { |
| 62 | $url = static::classUrl(); |
| 63 | return static::_requestPage($url, \WPForms\Vendor\Stripe\Collection::class, $params, $opts); |
| 64 | } |
| 65 | /** |
| 66 | * Returns the shipping rate object with the given ID. |
| 67 | * |
| 68 | * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key |
| 69 | * @param null|array|string $opts |
| 70 | * |
| 71 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 72 | * |
| 73 | * @return \Stripe\ShippingRate |
| 74 | */ |
| 75 | public static function retrieve($id, $opts = null) |
| 76 | { |
| 77 | $opts = \WPForms\Vendor\Stripe\Util\RequestOptions::parse($opts); |
| 78 | $instance = new static($id, $opts); |
| 79 | $instance->refresh(); |
| 80 | return $instance; |
| 81 | } |
| 82 | /** |
| 83 | * Updates an existing shipping rate object. |
| 84 | * |
| 85 | * @param string $id the ID of the resource to update |
| 86 | * @param null|array $params |
| 87 | * @param null|array|string $opts |
| 88 | * |
| 89 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 90 | * |
| 91 | * @return \Stripe\ShippingRate the updated resource |
| 92 | */ |
| 93 | public static function update($id, $params = null, $opts = null) |
| 94 | { |
| 95 | self::_validateParams($params); |
| 96 | $url = static::resourceUrl($id); |
| 97 | list($response, $opts) = static::_staticRequest('post', $url, $params, $opts); |
| 98 | $obj = \WPForms\Vendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts); |
| 99 | $obj->setLastResponse($response); |
| 100 | return $obj; |
| 101 | } |
| 102 | } |
| 103 |