Cheddar API Documentation

This is the complete API documentation for connecting to the Cheddar 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 Cheddar: Cheddar handles subscription billing with pricing plans, customer subscriptions, tracked usage, invoices, charges, refunds, and promotions. Keep reading to get started.

Quickstart

Before you run your first Cheddar 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 Cheddar connection — create or choose one in Connections. Note its connectionId.

Every Cheddar action uses the same URL pattern:

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

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

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/cheddar/latest/actions/get-customer" \
  --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 Cheddar account that should run the action. MindCloud stores and refreshes the Cheddar 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.

Cheddar actions

All 24 published actions for this Cheddar version. Each page documents the endpoint, arguments, and response controls.

• POSTAdd Custom Charge or Credit
• PUTAdd Item Quantity
• PUTCancel Subscription
• POSTCreate Customer
• POSTCreate One-Time Invoice
• DELETEDelete Custom Charge or Credit
• DELETEDelete Customer
• GETGet Customer
• GETGet Pricing Plan
• GETGet Promotion
• POSTImport Customers
• POSTIssue Refund
• PUTIssue Void
• PUTIssue Void or Refund
• GETList Customers
• GETList Pricing Plans
• GETList Promotions
• PUTRemove Item Quantity
• PUTRun Outstanding Invoice
• PUTSend or Resend Invoice Email
• PUTSet Item Quantity
• PUTUpdate Customer
• PUTUpdate Customer and Subscription
• PUTUpdate Subscription

Related apps

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

StripeShopifySquareWooCommerceXeroThinkificWhopGumroad