Skip to main content

CreateCheckoutRequest

checkout object[]required
  • Array [
  • emailstring

    The email of the customer to send the receipt to. Only applicable if collect_customer_on_stripe is false

    namestring

    The name of the customer to send the receipt to. Only applicable if collect_customer_on_stripe is false

    collect_customer_on_stripeboolean

    Whether to collect customer information on stripe during checkout

    Default value: false
    coupon_codestring

    The coupon code to apply to the checkout

    success_urlstringrequired

    The url to redirect to after a successful checkout

    cancel_urlstringrequired

    The url to redirect to after a cancelled checkout

    application_fee_amountinteger

    The amount to charge as an application fee in cents

    stripe_account_idstringrequired

    The stripe account id to use for this checkout

    line_items object[]required
  • Array [
  • ksuidstringrequired

    The ksuid of the item/bundle associated with this line item

    entity_typestringrequired

    The type of the line item, either 'item' or 'bundle'

    namestringrequired

    The name of the product associated with this line item

    includesstring[]

    The list of items included in this line item if it's a bundle

    event_ksuidstringrequired

    The ksuid of the event associated with this item

    price_idstringrequired

    The price id of the product in stripe

    quantityinteger

    The quantity of this item to add to the checkout

    Default value: 1
  • ]
  • ]
  • CreateCheckoutRequest
    {
    "checkout": [
    {
    "email": "string",
    "name": "string",
    "collect_customer_on_stripe": false,
    "coupon_code": "string",
    "success_url": "string",
    "cancel_url": "string",
    "application_fee_amount": 0,
    "stripe_account_id": "string",
    "line_items": [
    {
    "ksuid": "string",
    "entity_type": "string",
    "name": "string",
    "includes": [
    "string"
    ],
    "event_ksuid": "string",
    "price_id": "string",
    "quantity": 1
    }
    ]
    }
    ]
    }