GET
/
checkout
/
sessions
/
{id}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Id of the Checkout Session to retrieve

Response

200 - application/json
id
string

Identifier that can be used to retrieve the Checkout Session

amount_kg
number

Amount of carbon credits to be purchased upon checkout completion, in kilograms

price_usd_cents
number

Total price to be charged upon checkout completion, in USD cents

success_url
string

URL the customer will be redirected to after they complete Checkout.

cancel_url
string

URL the customer will be redirected to if they click the "back" button in Checkout.

checkout_url
string

URL to the Checkout Session. Redirect the customer to this URL to take them to Checkout.

state
string

The status of the Checkout Session, one of open, complete, or expired.

  • open - The checkout session is still in progress. Payment processing has not started.
  • complete - The checkout session is complete. Payment processing may still be in progress.
  • expired - The checkout session has expired. No further processing will occur.
expires_on
string

Timestamp of when the session will expire.

completed_on
string | null

Timestamp of when the session was completed. Null if session has not been completed.

portfolio_id
string

Id of the portfolio the customer will purchase from when completing Checkout.

subaccount_id
string | null

Id of the subaccount associated with the customer

order_description
string | null

Description to be associated with the order created from this session.

order_webhook_url
string | null

Webhook URL for updates to the order created from this session.