Global API
...
Request
Checkout URL

Checkout URL - Stripe

2min

The following properties can be provided to create a Checkout URL in Stripe. Those marked with * are required.

Checkout URL

Field Name

Data Type

Description

mode* 

string

The mode of the Checkout Session. Possible values are payment, setup, and subscription.

ProcessorId*

string

Stripe Processor Id

Action*

string

createCheckoutURL

cancel_url

string

The URL to which the customer will be directed if they decide to cancel the payment and return to your website.

success_url

string

The URL to which Stripe should send customers when payment or setup is complete.

payment_method_types

list

A list of the types of payment methods (e.g. card) this Checkout Session can accept.

customer

string

  • The ID of an existing Customer, if one exists.
  • If a customer's email is valid, it's prefilled and uneditable in Checkout. If not, the email entered during the session is set to the customer.
  • If blank, Checkout will create a new Customer object based on information provided during the payment flow.

customer_email

string

If provided, this value will be used when the Customer object is created. If not provided, customers will be asked to enter their email address.

line_items

list

list of line items



Line Items

Field Name

Data Type

Description

price

string

The ID of the Price or Plan object. One of the prices, price_data, or amount is required.

price_data

object

Data used to generate a new Price object inline. One of price, price_data, or amount is required.

amount

integer

The amount to be collected per unit of the line item. If specified, must also pass currency and name.

currency

string

Three-letter ISO currency code, in lowercase. Must be a supported currency

name

string

The name for the item to be displayed on the Checkout page.

quantity

integer

Quantity of items

For more fields, refer Stripe.