The Customer Session object

Attributes

client _ secret string The client secret of this Customer Session. Used on the client to set up secure access to the given customer. The client secret can be used to provide access to customer from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret.
components object This hash defines which component is enabled and the features it supports.
customer string Expandable The Customer the Customer Session was created for.
expires _ at timestamp The timestamp at which this Customer Session will expire.

More attributes

object string, value is "customer_session"
created timestamp
customer _ account nullable string
livemode boolean

{ "object": "customer_session", "client_secret": "_POpxYpmkXdtttYtZQYhrsOJZ2RCQ9kCqqXRU6qrP5c4Jgje", "components": { "buy_button": { "enabled": false }, "pricing_table": { "enabled": true } }, "customer": "cus_PO34b57IOUb83c", "expires_at": 1684790027, "livemode": false}

Create a Customer Session

POST / v1 / customer_sessions

Creates a Customer Session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.

Parameters

components object Required Configuration for each component. At least 1 component must be enabled.
customer string The ID of an existing customer for which to create the Customer Session.

More parameters

customer _ account string

Returns

Returns a Customer Session object.

Response

{ "object": "customer_session", "client_secret": "_POpxYpmkXdtttYtZQYhrsOJZ2RCQ9kCqqXRU6qrP5c4Jgje", "components": { "buy_button": { "enabled": false }, "pricing_table": { "enabled": true } }, "customer": "cus_PO34b57IOUb83c", "expires_at": 1684790027, "livemode": false}