Configuration.php 2.1 KB

123456789101112131415161718192021222324252627282930313233
  1. <?php
  2. // File generated from our OpenAPI spec
  3. namespace Stripe\BillingPortal;
  4. /**
  5. * A portal configuration describes the functionality and behavior of a portal
  6. * session.
  7. *
  8. * @property string $id Unique identifier for the object.
  9. * @property string $object String representing the object's type. Objects of the same type share the same value.
  10. * @property bool $active Whether the configuration is active and can be used to create portal sessions.
  11. * @property null|string|\Stripe\StripeObject $application ID of the Connect Application that created the configuration.
  12. * @property \Stripe\StripeObject $business_profile
  13. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
  14. * @property null|string $default_return_url The default URL to redirect customers to when they click on the portal's link to return to your website. This can be <a href="https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url">overriden</a> when creating the session.
  15. * @property \Stripe\StripeObject $features
  16. * @property bool $is_default Whether the configuration is the default. If <code>true</code>, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
  17. * @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.
  18. * @property \Stripe\StripeObject $login_page
  19. * @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.
  20. * @property int $updated Time at which the object was last updated. Measured in seconds since the Unix epoch.
  21. */
  22. class Configuration extends \Stripe\ApiResource
  23. {
  24. const OBJECT_NAME = 'billing_portal.configuration';
  25. use \Stripe\ApiOperations\All;
  26. use \Stripe\ApiOperations\Create;
  27. use \Stripe\ApiOperations\Retrieve;
  28. use \Stripe\ApiOperations\Update;
  29. }