| 1 |
<?php |
| 2 |
|
| 3 |
// File generated from our OpenAPI spec |
| 4 |
|
| 5 |
namespace Stripe; |
| 6 |
|
| 7 |
/** |
| 8 |
* Sometimes you want to add a charge or credit to a customer, but actually charge |
| 9 |
* or credit the customer's card only at the end of a regular billing cycle. This |
| 10 |
* is useful for combining several charges (to minimize per-transaction fees), or |
| 11 |
* for having Stripe tabulate your usage-based billing totals. |
| 12 |
* |
| 13 |
* Related guide: <a |
| 14 |
* href="https://stripe.com/docs/billing/invoices/subscription#adding-upcoming-invoice-items">Subscription |
| 15 |
* Invoices</a>. |
| 16 |
* |
| 17 |
* @property string $id Unique identifier for the object. |
| 18 |
* @property string $object String representing the object's type. Objects of the same type share the same value. |
| 19 |
* @property int $amount Amount (in the <code>currency</code> specified) of the invoice item. This should always be equal to <code>unit_amount * quantity</code>. |
| 20 |
* @property string $currency Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>. |
| 21 |
* @property string|\Stripe\Customer $customer The ID of the customer who will be billed when this invoice item is billed. |
| 22 |
* @property int $date Time at which the object was created. Measured in seconds since the Unix epoch. |
| 23 |
* @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users. |
| 24 |
* @property bool $discountable If true, discounts will apply to this invoice item. Always false for prorations. |
| 25 |
* @property null|(string|\Stripe\Discount)[] $discounts The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use <code>expand[]=discounts</code> to expand each discount. |
| 26 |
* @property null|string|\Stripe\Invoice $invoice The ID of the invoice this invoice item belongs to. |
| 27 |
* @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. |
| 28 |
* @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. |
| 29 |
* @property \Stripe\StripeObject $period |
| 30 |
* @property null|\Stripe\Plan $plan If the invoice item is a proration, the plan of the subscription that the proration was computed for. |
| 31 |
* @property null|\Stripe\Price $price The price of the invoice item. |
| 32 |
* @property bool $proration Whether the invoice item was created automatically as a proration adjustment when the customer switched plans. |
| 33 |
* @property int $quantity Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for. |
| 34 |
* @property null|string|\Stripe\Subscription $subscription The subscription that this invoice item has been created for, if any. |
| 35 |
* @property string $subscription_item The subscription item that this invoice item has been created for, if any. |
| 36 |
* @property null|\Stripe\TaxRate[] $tax_rates The tax rates which apply to the invoice item. When set, the <code>default_tax_rates</code> on the invoice do not apply to this invoice item. |
| 37 |
* @property null|string|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this invoice item belongs to. |
| 38 |
* @property null|int $unit_amount Unit amount (in the <code>currency</code> specified) of the invoice item. |
| 39 |
* @property null|string $unit_amount_decimal Same as <code>unit_amount</code>, but contains a decimal value with at most 12 decimal places. |
| 40 |
*/ |
| 41 |
class InvoiceItem extends ApiResource |
| 42 |
{ |
| 43 |
const OBJECT_NAME = 'invoiceitem'; |
| 44 |
|
| 45 |
use ApiOperations\All; |
| 46 |
use ApiOperations\Create; |
| 47 |
use ApiOperations\Delete; |
| 48 |
use ApiOperations\Retrieve; |
| 49 |
use ApiOperations\Update; |
| 50 |
} |
| 51 |
|
