Update a client-session
Updates an existing client session. Each top-level object you send (customer, plan, subscription, payment, options) replaces that object in the session as a whole; objects you omit stay unchanged. The session ID doesn’t change. A checkout that is already mounted doesn’t pick up the change — remount it with the same client token to show the updated session.
Authorizations
Authentication header of the form api key, where api key is your organization api key.
Headers
Specifies the version of the API to use
1.0.0 Path Parameters
The ID of the client session to update
Body
Update session data
Customer for the session. Replaces the session's customer object as a whole; omit it to keep the current customer.
Session options. Replaces the session's options object as a whole; omit it to keep the current options.
Payment data, such as metadata. Replaces the session's payment object as a whole; omit it to keep the current payment data.
Plan to charge. Replaces the session's plan object as a whole, so a custom price set earlier is dropped unless you send it again. A mounted checkout keeps the previous price until you remount it.
Existing subscription to update, or metadata for a new one. Replaces the session's subscription object as a whole; omit it to keep the current subscription data.
Response
OK
Currency-specific pricing and display information
Customer information associated with the client session
Expiration date and time of the client session
"2021-08-12T16:14:08.578695"
ClientSession is a unique session identifier generated for the client
"d3b07384-d9a5-4d16-a5b1-3fa3d9b0b123"
Payment information associated with the client session
Plan information associated with the client session
Subscription information associated with the client session