InvoiceLineItem.php — Paid Membership Plugin, Ecommerce, User Registration Form, Login Form, User Profile & Restrict Content – ProfilePress 4.17.1

wp-user-avatar / third-party / vendor / stripe / stripe-php / lib / InvoiceLineItem.php

wp-user-avatar / third-party / vendor / stripe / stripe-php / lib Last commit date

InvoiceLineItem.php

68 lines

1	<?php
2
3	// File generated from our OpenAPI spec
4	namespace ProfilePressVendor\Stripe;
5
6	/**
7	* Invoice Line Items represent the individual lines within an <a href="https://stripe.com/docs/api/invoices">invoice</a> and only exist within the context of an invoice.
8	*
9	* Each line item is backed by either an <a href="https://stripe.com/docs/api/invoiceitems">invoice item</a> or a <a href="https://stripe.com/docs/api/subscription_items">subscription item</a>.
10	*
11	* @property string $id Unique identifier for the object.
12	* @property string $object String representing the object's type. Objects of the same type share the same value.
13	* @property int $amount The amount, in cents (or local equivalent).
14	* @property null\|int $amount_excluding_tax The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts.
15	* @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>.
16	* @property null\|string $description An arbitrary string attached to the object. Often useful for displaying to users.
17	* @property null\|\Stripe\StripeObject[] $discount_amounts The amount of discount calculated per discount for this line item.
18	* @property bool $discountable If true, discounts will apply to this line item. Always false for prorations.
19	* @property (string\|\Stripe\Discount)[] $discounts The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use <code>expand[]=discounts</code> to expand each discount.
20	* @property null\|string $invoice The ID of the invoice that contains this line item.
21	* @property null\|string\|\Stripe\InvoiceItem $invoice_item The ID of the <a href="https://stripe.com/docs/api/invoiceitems">invoice item</a> associated with this line item if any.
22	* @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.
23	* @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. Note that for line items with <code>type=subscription</code>, <code>metadata</code> reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.
24	* @property \Stripe\StripeObject $period
25	* @property null\|\Stripe\Plan $plan The plan of the subscription, if the line item is a subscription or a proration.
26	* @property null\|\Stripe\StripeObject[] $pretax_credit_amounts Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item.
27	* @property null\|\Stripe\Price $price The price of the line item.
28	* @property bool $proration Whether this is a proration.
29	* @property null\|\Stripe\StripeObject $proration_details Additional details for proration line items
30	* @property null\|int $quantity The quantity of the subscription, if the line item is a subscription or a proration.
31	* @property null\|string\|\Stripe\Subscription $subscription The subscription that the invoice item pertains to, if any.
32	* @property null\|string\|\Stripe\SubscriptionItem $subscription_item The subscription item that generated this line item. Left empty if the line item is not an explicit result of a subscription.
33	* @property \Stripe\StripeObject[] $tax_amounts The amount of tax calculated per tax rate for this line item
34	* @property \Stripe\TaxRate[] $tax_rates The tax rates which apply to the line item.
35	* @property string $type A string identifying the type of the source of this line item, either an <code>invoiceitem</code> or a <code>subscription</code>.
36	* @property null\|string $unit_amount_excluding_tax The amount in cents (or local equivalent) representing the unit amount for this line item, excluding all tax and discounts.
37	*/
38	class InvoiceLineItem extends ApiResource
39	{
40	const OBJECT_NAME = 'line_item';
41	use ApiOperations\Update;
42	/**
43	* Updates an invoice’s line item. Some fields, such as <code>tax_amounts</code>,
44	* only live on the invoice line item, so they can only be updated through this
45	* endpoint. Other fields, such as <code>amount</code>, live on both the invoice
46	* item and the invoice line item, so updates on this endpoint will propagate to
47	* the invoice item as well. Updating an invoice’s line item is only possible
48	* before the invoice is finalized.
49	*
50	* @param string $id the ID of the resource to update
51	* @param null\|array $params
52	* @param null\|array\|string $opts
53	*
54	* @throws \Stripe\Exception\ApiErrorException if the request fails
55	*
56	* @return \Stripe\InvoiceLineItem the updated resource
57	*/
58	public static function update($id, $params = null, $opts = null)
59	{
60	self::_validateParams($params);
61	$url = static::resourceUrl($id);
62	list($response, $opts) = static::_staticRequest('post', $url, $params, $opts);
63	$obj = \ProfilePressVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts);
64	$obj->setLastResponse($response);
65	return $obj;
66	}
67	}
68