Skip to main content
PATCH
Update a client-session

Authorizations

Authorization
string
header
required

Authentication header of the form api key, where api key is your organization api key.

Headers

X-API-Version
enum<string>
default:2.0.0
required

Specifies the version of the API to use

Available options:
2.0.0

Path Parameters

id
string
required

The ID of the client session to update

Body

application/json

Update session data

customer
object

Customer for the session. Replaces the session's customer object as a whole; omit it to keep the current customer.

options
object

Session options. Replaces the session's options object as a whole; omit it to keep the current options.

payment
object

Payment data, such as metadata. Replaces the session's payment object as a whole; omit it to keep the current payment data.

plan
object

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.

subscription
object

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

Returns the updated client session object.

id
string

ClientSession is a unique session identifier generated for the client

Example:

"d3b07384-d9a5-4d16-a5b1-3fa3d9b0b123"

currency_details
object

Currency-specific pricing and display information

customer
object

Customer information associated with the client session

expiry_date
string

Expiration date and time of the client session

Example:

"2021-08-12T16:14:08.578695"

payment
object

Payment information associated with the client session

plan
object

Plan information associated with the client session

subscription
object

Subscription information associated with the client session