checkoutsessionep

type CheckoutSessionResponse struct {
	// Resource type identifier.
	Object constants.ObjectType `json:"object" validate:"required,enum=checkout_session"`
	// Client secret for the Stripe embedded checkout session.
	//
	// Pass this to Stripe.js to mount the embedded checkout form.
	CheckoutSessionClientSecret string `json:"checkout_session_client_secret" validate:"required,max=255" sensitive:"true"` // #nosec G117 - Struct field, not a hardcoded credential
}

type CheckoutSessionSvc interface {
	CreateCheckoutSession(ctx context.Context, req *CreateCheckoutSessionRequest) (*CheckoutSessionResponse, *apierror.APIError)
}

type CheckoutSessionSvcConfig struct {
	// CoreSalesClient (required) is the core-service sales gRPC client.
	CoreSalesClient pb.CoreSalesServiceClient
}

type CreateCheckoutSessionEndpoint struct{}

type CreateCheckoutSessionRequest struct {
	// ID of the sales order to collect payment for.
	//
	// It is recorded on the Stripe session so that the resulting payment is linked back to this order once Stripe reports it as succeeded.
	OrderID string `json:"order_id" validate:"required"`
	// Human-readable order number shown to the customer during checkout.
	//
	// Appears in the name of the single line item on the Stripe payment form, prefixed with `SO #`.
	OrderNumber string `json:"order_number" validate:"required,max=255"`
	// Amount to charge the customer, in cents.
	//
	// Billed in US dollars as one line item covering the whole order.
	OrderTotalCents int64 `json:"order_total_cents" validate:"required"`
	// Customer purchase order (PO) number to associate with the payment.
	//
	// Appears as the description of the checkout line item, prefixed with `PO #`.
	CustomerPO field.Optional[string] `json:"customer_po,omitzero" validate:"omitempty,max=255"`
}