Create Stripe Session

Creates a Stripe Checkout session for a storefront cart and returns the redirect URL.

POST

Authentication

Requirement: Not specified
Credential type: Not specified
Scopes: Not specified

Permissions

No authentication is required; the customer is identified from the storefront session, cart token cookie, or guest checkout details.

Headers

Name	Required	Type	Details
`Cookie`	Yes	Not specified	Description: Value used by this operation.
`Authorization`	Yes	Not specified	Description: Bearer credential used to authenticate the request.
`Host`	Yes	Not specified	Description: Value used by this operation.

Path Parameters

This operation has no path parameters.

Query Parameters

This operation does not accept query parameters.

Request Body

Schema: key/value map

Field	Required	Type	Details
`customer_id`	No	string	Description: Identifier for customer.
`guest_email`	No	string	Description: Text value.
`guest_name`	No	string	Description: Text value.
`guest_phone`	No	string	Description: Text value.
`payment_method`	No	string	Description: Text value.
`payment_method_title`	No	string	Description: Display title.
`shipping_method`	No	string	Description: Text value.
`shipping_method_title`	No	string	Description: Display title.
`customer_note`	No	string	Description: Text value.
`use_saved_card`	No	string	Description: Text value.
`subscription_id`	No	string	Description: Identifier for subscription.
`current_subscription_id`	No	string	Description: Identifier for current subscription.
`interval`	No	string	Description: Text value.
`buy_now_item_id`	No	string	Description: Identifier for buy now item.
`modal`	No	string	Description: Text value.
`success_url`	No	string	Description: Text value.
`cancel_url`	No	string	Description: Text value.

Response Body

Example 200 response

json

{
  "ok": "string",
  "redirect_url": "string",
  "session_id": 1
}

Errors

400 bad_request500 internal_server_error

Availability

Available in: v0.1.0
Available since: v0.1.0
Implementation: Available
Deprecation: Not specified
Rate limits: Not specified

Example request

POST/__runtime/checkout/stripe/session

Base URLhttps://api.modusell.com

curl --request POST \
  --url "https://api.modusell.com/__runtime/checkout/stripe/session" \
  --header "Content-Type: application/json" \
  --data '{"customer_id":1,"guest_email":"user@example.com","guest_name":"VALUE","guest_phone":"VALUE","payment_method":"VALUE","payment_method_title":"VALUE","shipping_method":"VALUE","shipping_method_title":"VALUE","customer_note":"VALUE","use_saved_card":"VALUE","subscription_id":1,"current_subscription_id":1,"interval":"VALUE","buy_now_item_id":1,"modal":"VALUE","success_url":"https://example.com","cancel_url":"https://example.com"}'

Response

Examples are not available for this release.

Authentication

Authentication requirements are not specified for this operation.