TaxRate.php 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. <?php
  2. // File generated from our OpenAPI spec
  3. namespace Stripe;
  4. /**
  5. * Tax rates can be applied to <a
  6. * href="https://stripe.com/docs/billing/invoices/tax-rates">invoices</a>, <a
  7. * href="https://stripe.com/docs/billing/subscriptions/taxes">subscriptions</a> and
  8. * <a
  9. * href="https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates">Checkout
  10. * Sessions</a> to collect tax.
  11. *
  12. * Related guide: <a href="https://stripe.com/docs/billing/taxes/tax-rates">Tax
  13. * Rates</a>.
  14. *
  15. * @property string $id Unique identifier for the object.
  16. * @property string $object String representing the object's type. Objects of the same type share the same value.
  17. * @property bool $active Defaults to <code>true</code>. When set to <code>false</code>, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.
  18. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
  19. * @property null|string $description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
  20. * @property string $display_name The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
  21. * @property bool $inclusive This specifies if the tax rate is inclusive or exclusive.
  22. * @property null|string $jurisdiction The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
  23. * @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.
  24. * @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.
  25. * @property float $percentage This represents the tax rate percent out of 100.
  26. */
  27. class TaxRate extends ApiResource
  28. {
  29. const OBJECT_NAME = 'tax_rate';
  30. use ApiOperations\All;
  31. use ApiOperations\Create;
  32. use ApiOperations\Retrieve;
  33. use ApiOperations\Update;
  34. }