| 1 |
<?php |
| 2 |
|
| 3 |
// File generated from our OpenAPI spec |
| 4 |
|
| 5 |
namespace Stripe\BillingPortal; |
| 6 |
|
| 7 |
/** |
| 8 |
* The Billing customer portal is a Stripe-hosted UI for subscription and billing |
| 9 |
* management. |
| 10 |
* |
| 11 |
* A portal configuration describes the functionality and features that you want to |
| 12 |
* provide to your customers through the portal. |
| 13 |
* |
| 14 |
* A portal session describes the instantiation of the customer portal for a |
| 15 |
* particular customer. By visiting the session's URL, the customer can manage |
| 16 |
* their subscriptions and billing details. For security reasons, sessions are |
| 17 |
* short-lived and will expire if the customer does not visit the URL. Create |
| 18 |
* sessions on-demand when customers intend to manage their subscriptions and |
| 19 |
* billing details. |
| 20 |
* |
| 21 |
* Learn more in the <a |
| 22 |
* href="https://stripe.com/docs/billing/subscriptions/integrating-customer-portal">integration |
| 23 |
* guide</a>. |
| 24 |
* |
| 25 |
* @property string $id Unique identifier for the object. |
| 26 |
* @property string $object String representing the object's type. Objects of the same type share the same value. |
| 27 |
* @property string|\Stripe\BillingPortal\Configuration $configuration The configuration used by this session, describing the features available. |
| 28 |
* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 29 |
* @property string $customer The ID of the customer for this session. |
| 30 |
* @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. |
| 31 |
* @property null|string $locale The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s <code>preferred_locales</code> or browser’s locale is used. |
| 32 |
* @property null|string $on_behalf_of The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this <code>on_behalf_of</code> account appear in the portal. For more information, see the <a href="https://stripe.com/docs/connect/charges-transfers#on-behalf-of">docs</a>. Use the <a href="https://stripe.com/docs/api/accounts/object#account_object-settings-branding">Accounts API</a> to modify the <code>on_behalf_of</code> account's branding settings, which the portal displays. |
| 33 |
* @property string $return_url The URL to redirect customers to when they click on the portal's link to return to your website. |
| 34 |
* @property string $url The short-lived URL of the session that gives customers access to the customer portal. |
| 35 |
*/ |
| 36 |
class Session extends \Stripe\ApiResource |
| 37 |
{ |
| 38 |
const OBJECT_NAME = 'billing_portal.session'; |
| 39 |
|
| 40 |
use \Stripe\ApiOperations\Create; |
| 41 |
} |
| 42 |
|
