stripekit::CheckoutSession Struct Reference

A Stripe Checkout session: one attempt by a customer to pay or subscribe. More...

#include <Models.h>

Public Attributes
std::string	id
	Stripe-assigned checkout session identifier.
std::string	customer_id
	Stripe customer identifier associated with the session.
std::string	subscription_id
	Stripe subscription identifier created by checkout, when present.
std::string	payment_intent_id
	Stripe payment intent identifier created by checkout, when present.
std::string	status
	Session status, for example open, complete, or expired.
std::string	mode
	Checkout mode, for example subscription or payment.
std::string	url
	Redirect URL for hosted checkout.
std::string	currency
	ISO currency code, for example usd.
std::int64_t	amount_total = 0
	Total amount in the smallest currency unit.
bool	livemode = false
	True when the object belongs to a live Stripe account.
std::unordered_map< std::string, std::string >	metadata
	Free-form metadata key/value pairs attached to this session.

Detailed Description

A Stripe Checkout session: one attempt by a customer to pay or subscribe.

Send the customer to url to start payment. subscription_id or payment_intent_id is filled in depending on whether mode is subscription or payment.

See also

https://docs.stripe.com/api/checkout/sessions/object

Definition at line 54 of file Models.h.

Member Data Documentation

id

std::string stripekit::CheckoutSession::id

Stripe-assigned checkout session identifier.

Definition at line 56 of file Models.h.

customer_id

std::string stripekit::CheckoutSession::customer_id

Stripe customer identifier associated with the session.

Definition at line 59 of file Models.h.

subscription_id

std::string stripekit::CheckoutSession::subscription_id

Stripe subscription identifier created by checkout, when present.

Definition at line 62 of file Models.h.

payment_intent_id

std::string stripekit::CheckoutSession::payment_intent_id

Stripe payment intent identifier created by checkout, when present.

Definition at line 65 of file Models.h.

status

std::string stripekit::CheckoutSession::status

Session status, for example open, complete, or expired.

Definition at line 68 of file Models.h.

mode

std::string stripekit::CheckoutSession::mode

Checkout mode, for example subscription or payment.

Definition at line 71 of file Models.h.

url

std::string stripekit::CheckoutSession::url

Redirect URL for hosted checkout.

Definition at line 74 of file Models.h.

currency

std::string stripekit::CheckoutSession::currency

ISO currency code, for example usd.

Definition at line 77 of file Models.h.

amount_total

std::int64_t stripekit::CheckoutSession::amount_total = 0

Total amount in the smallest currency unit.

Definition at line 80 of file Models.h.

livemode

bool stripekit::CheckoutSession::livemode = false

True when the object belongs to a live Stripe account.

Definition at line 83 of file Models.h.

metadata

std::unordered_map<std::string, std::string> stripekit::CheckoutSession::metadata

Free-form metadata key/value pairs attached to this session.

Definition at line 86 of file Models.h.

---

The documentation for this struct was generated from the following file:

• include/StripeKit/Models.h