CreditNoteLineItem.php 2.3 KB

123456789101112131415161718192021222324252627282930
  1. <?php
  2. // File generated from our OpenAPI spec
  3. namespace Stripe;
  4. /**
  5. * The credit note line item object.
  6. *
  7. * @property string $id Unique identifier for the object.
  8. * @property string $object String representing the object's type. Objects of the same type share the same value.
  9. * @property int $amount The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.
  10. * @property null|int $amount_excluding_tax The integer amount in cents (or local equivalent) representing the amount being credited for this line item, excluding all tax and discounts.
  11. * @property null|string $description Description of the item being credited.
  12. * @property int $discount_amount The integer amount in cents (or local equivalent) representing the discount being credited for this line item.
  13. * @property \Stripe\StripeObject[] $discount_amounts The amount of discount calculated per discount for this line item
  14. * @property null|string $invoice_line_item ID of the invoice line item being credited
  15. * @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.
  16. * @property null|int $quantity The number of units of product being credited.
  17. * @property \Stripe\StripeObject[] $tax_amounts The amount of tax calculated per tax rate for this line item
  18. * @property \Stripe\TaxRate[] $tax_rates The tax rates which apply to the line item.
  19. * @property string $type The type of the credit note line item, one of <code>invoice_line_item</code> or <code>custom_line_item</code>. When the type is <code>invoice_line_item</code> there is an additional <code>invoice_line_item</code> property on the resource the value of which is the id of the credited line item on the invoice.
  20. * @property null|int $unit_amount The cost of each unit of product being credited.
  21. * @property null|string $unit_amount_decimal Same as <code>unit_amount</code>, but contains a decimal value with at most 12 decimal places.
  22. * @property null|string $unit_amount_excluding_tax The amount in cents (or local equivalent) representing the unit amount being credited for this line item, excluding all tax and discounts.
  23. */
  24. class CreditNoteLineItem extends ApiResource
  25. {
  26. const OBJECT_NAME = 'credit_note_line_item';
  27. }