| 1 |
<?php |
| 2 |
|
| 3 |
// File generated from our OpenAPI spec |
| 4 |
|
| 5 |
namespace Stripe; |
| 6 |
|
| 7 |
/** |
| 8 |
* Shipping rates describe the price of shipping presented to your customers and |
| 9 |
* can be applied to <a |
| 10 |
* href="https://stripe.com/docs/payments/checkout/shipping">Checkout Sessions</a> |
| 11 |
* to collect shipping costs. |
| 12 |
* |
| 13 |
* @property string $id Unique identifier for the object. |
| 14 |
* @property string $object String representing the object's type. Objects of the same type share the same value. |
| 15 |
* @property bool $active Whether the shipping rate can be used for new purchases. Defaults to <code>true</code>. |
| 16 |
* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 17 |
* @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. |
| 18 |
* @property null|string $display_name The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. |
| 19 |
* @property \Stripe\StripeObject $fixed_amount |
| 20 |
* @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. |
| 21 |
* @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. |
| 22 |
* @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>. |
| 23 |
* @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>. |
| 24 |
* @property string $type The type of calculation to use on the shipping rate. Can only be <code>fixed_amount</code> for now. |
| 25 |
*/ |
| 26 |
class ShippingRate extends ApiResource |
| 27 |
{ |
| 28 |
const OBJECT_NAME = 'shipping_rate'; |
| 29 |
|
| 30 |
use ApiOperations\All; |
| 31 |
use ApiOperations\Create; |
| 32 |
use ApiOperations\Retrieve; |
| 33 |
use ApiOperations\Update; |
| 34 |
|
| 35 |
const TAX_BEHAVIOR_EXCLUSIVE = 'exclusive'; |
| 36 |
const TAX_BEHAVIOR_INCLUSIVE = 'inclusive'; |
| 37 |
const TAX_BEHAVIOR_UNSPECIFIED = 'unspecified'; |
| 38 |
|
| 39 |
const TYPE_FIXED_AMOUNT = 'fixed_amount'; |
| 40 |
} |
| 41 |
|
