Checkout Page API Documentation

This is the complete API documentation for connecting to the Checkout Page API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Checkout Page: Manage checkout pages, forms, events, customers, payments, subscriptions, coupons, products, and ticket operations in Checkout Page. Keep reading to get started.

Quickstart

Before you run your first Checkout Page request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Checkout Page connection — create or choose one in Connections. Note its connectionId.

Every Checkout Page action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/checkoutPage/latest/actions/{actionSlug}

You need a MindCloud API Key and a Checkout Page connection. Then call an action such as Get Checkout Page:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/checkoutPage/latest/actions/get-checkout-page" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Checkout Page account that should run the action. MindCloud stores and refreshes the Checkout Page credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

Checkout Page actions

All 40 published actions for this Checkout Page version. Each page documents the endpoint, arguments, and response controls.

• DELETEArchive Checkout Page
• POSTCreate Checkout Page
• POSTCreate Coupon
• POSTCreate Event
• POSTCreate Field For Checkout Page
• POSTCreate Field For Event
• POSTCreate Field For Form
• POSTCreate Form
• POSTCreate Ticket Group
• POSTCreate Ticket Type
• GETGet Checkout Page
• GETGet Customer Details
• GETGet Event
• GETGet Form
• GETGet Product
• GETGet Ticket Group
• GETGet Ticket Type
• GETList Bookings
• GETList Checkout Pages
• GETList Coupons
• GETList Customers
• GETList Events
• GETList Fields For Checkout Page
• GETList Fields For Event
• GETList Fields For Form
• GETList Forms
• GETList Payments
• GETList Subscriptions
• GETList Ticket Groups
• GETList Ticket Types
• PUTUpdate Checkout Page
• PUTUpdate Event
• PUTUpdate Field For Checkout Page
• PUTUpdate Field For Event
• PUTUpdate Field For Form
• PUTUpdate Form
• PUTUpdate Product
• PUTUpdate Ticket Group
• PUTUpdate Ticket Type
• GETValidate Ticket

Related apps

More Commerce apps on the Universal API, behind the same REST shape. Or browse all apps.

StripeShopifySquareWooCommerceXeroThinkificWhopGumroad