AccountSession.php 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. <?php
  2. // File generated from our OpenAPI spec
  3. namespace Stripe;
  4. /**
  5. * An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components.
  6. *
  7. * We recommend that you create an AccountSession each time you need to display an embedded component
  8. * to your user. Do not save AccountSessions to your database as they expire relatively
  9. * quickly, and cannot be used more than once.
  10. *
  11. * Related guide: <a href="https://stripe.com/docs/connect/get-started-connect-embedded-components">Connect embedded components</a>
  12. *
  13. * @property string $object String representing the object's type. Objects of the same type share the same value.
  14. * @property string $account The ID of the account the AccountSession was created for
  15. * @property string $client_secret <p>The client secret of this AccountSession. Used on the client to set up secure access to the given <code>account</code>.</p><p>The client secret can be used to provide access to <code>account</code> from your frontend. It should not be stored, logged, or exposed to anyone other than the connected account. Make sure that you have TLS enabled on any page that includes the client secret.</p><p>Refer to our docs to <a href="https://stripe.com/docs/connect/get-started-connect-embedded-components">setup Connect embedded components</a> and learn about how <code>client_secret</code> should be handled.</p>
  16. * @property \Stripe\StripeObject $components
  17. * @property int $expires_at The timestamp at which this AccountSession will expire.
  18. * @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.
  19. */
  20. class AccountSession extends ApiResource
  21. {
  22. const OBJECT_NAME = 'account_session';
  23. /**
  24. * Creates a AccountSession object that includes a single-use token that the
  25. * platform can use on their front-end to grant client-side API access.
  26. *
  27. * @param null|array $params
  28. * @param null|array|string $options
  29. *
  30. * @throws \Stripe\Exception\ApiErrorException if the request fails
  31. *
  32. * @return \Stripe\AccountSession the created resource
  33. */
  34. public static function create($params = null, $options = null)
  35. {
  36. self::_validateParams($params);
  37. $url = static::classUrl();
  38. list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
  39. $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
  40. $obj->setLastResponse($response);
  41. return $obj;
  42. }
  43. }