Getcheddar Cheddar API

Name: Cheddar API
Brand: Cheddar API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentPaymentsBilling Subscriptionsbasic10 EndpointsREST

For Agents

Manage SaaS subscription billing through Cheddar — create customers, change subscription plans, retrieve pricing plans, and import or delete customers. Uses HTTP Basic Auth and XML responses.

Install Jentic One Beta

Connect the Cheddar API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Cheddar API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Cheddar API.

Provision a new SaaS customer on a chosen pricing plan when a signup completes

Change a customer's subscription to a different plan when they upgrade or downgrade

Retrieve the full list of pricing plans for a product to render a pricing page

GET STARTED

Start building with Cheddar API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for Cheddar API, keeping it validated and agent-ready. Cheddar is a subscription billing and recurring payment platform aimed at SaaS businesses, with a long-running XML-over-HTTP API for managing pricing plans, customers, and their subscriptions. The API provides 10 endpoints covering plans, customer CRUD, subscription edits, customer imports, and bulk delete operations, all secured via HTTP Basic Auth. It is most often used by SaaS backends to provision new subscriptions, change plans, and retrieve plan and customer state on demand.

Use Cases

Patterns agents use Cheddar API for, with concrete tasks.

★ SaaS Signup Provisioning

When a SaaS user completes signup and selects a plan, the backend needs to create the customer record in Cheddar with the right plan code and billing details. The API's customer creation endpoint accepts the plan code, customer identity fields, and payment method, returning the customer record. This is the canonical path from signup form to recurring billing.

On signup, call `POST /customers/new/productCode/{productCode}` with the customer fields and chosen plan code, then store the returned customer code in your database.

Plan Change on Upgrade or Downgrade

When a customer upgrades or downgrades, the application needs to switch their subscription to a different plan code without losing billing continuity. The API's edit-subscription endpoint accepts a customer code and a new plan code and applies the change in line with Cheddar's proration rules.

Call `POST /customers/edit-subscription/productCode/{productCode}/code/{customerCode}` with the new plan code and confirm the response shows the updated plan.

Legacy Billing Migration

Teams moving from a homegrown billing system or another provider need to load thousands of existing customers into Cheddar without manually entering each one. The customer-import endpoint accepts a batch payload, so a one-off migration job can transfer customers en masse, preserving plan codes and billing identifiers.

Call `POST /customers/import/productCode/{productCode}` with the prepared customer batch and verify the response counts match the source CSV row count.

Agent-Driven Subscription Management

An AI agent in a support or admin tool can resolve 'upgrade this customer to the Pro plan' by discovering the edit-subscription operation through Jentic and executing it. The agent never holds the Basic Auth credentials directly — Jentic manages them — and confirms the new plan code back to the user.

Resolve a customer code from the support context and call `POST /customers/edit-subscription/productCode/{productCode}/code/{customerCode}` via Jentic, then return the new plan code to the requester.

Key Endpoints

10 endpoints — jentic publishes the only available openapi specification for cheddar api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/plans/get/productCode/{productCode}

Get all pricing plans

GET

/customers/get/productCode/{productCode}

Get all customers

POST

/customers/new/productCode/{productCode}

Create a new customer

POST

/customers/edit/productCode/{productCode}/code/{customerCode}

Update a customer and subscription

POST

/customers/edit-subscription/productCode/{productCode}/code/{customerCode}

Edit a subscription's plan

POST

/customers/delete/productCode/{productCode}/code/{customerCode}

Delete a customer

POST

/customers/import/productCode/{productCode}

Import customers in bulk

GET

/plans/get/productCode/{productCode}

Get all pricing plans

GET

/customers/get/productCode/{productCode}

Get all customers

POST

/customers/new/productCode/{productCode}

Create a new customer

POST

/customers/edit/productCode/{productCode}/code/{customerCode}

Update a customer and subscription

POST

/customers/edit-subscription/productCode/{productCode}/code/{customerCode}

Edit a subscription's plan

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Cheddar Basic Auth credentials are stored encrypted in the Jentic vault. Agents call Cheddar operations via Jentic and the platform injects the `Authorization: Basic …` header — the raw username and password never enter the agent's context.

Intent-based discovery

Agents search Jentic by intent (e.g. 'create a new customer in Cheddar' or 'change a subscription plan') and Jentic returns the matching operation with its input schema and product/customer code parameters.

Time to first call

Direct Cheddar integration: 2-3 days to handle the XML response shape, plan code mapping, and Basic Auth securely. Through Jentic: under an hour for the first call.

FAQs

Specific to using Cheddar API through Jentic.

Why is there no official OpenAPI spec for Cheddar API?

Cheddar does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Cheddar API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Cheddar API use?

The Cheddar API uses HTTP Basic Authentication. Through Jentic, the credential pair is stored encrypted and the `Authorization: Basic …` header is injected at execution time, so agents never receive the raw username and password.

Can I change a customer's subscription plan with the Cheddar API?

Yes. Call `POST /customers/edit-subscription/productCode/{productCode}/code/{customerCode}` with the new plan code to switch a customer's subscription.

Can I bulk-import customers into Cheddar?

Yes. Call `POST /customers/import/productCode/{productCode}` with the batch payload. This is the typical path for migrating from another billing system.

How do I create a new customer through Jentic?

Search Jentic for `create a new customer in Cheddar`, load the schema for `POST /customers/new/productCode/{productCode}`, and execute with the customer fields and plan code. Jentic handles the Basic Auth header from the vault.

Does the Cheddar API process card payments directly?

Cheddar handles recurring billing on top of an underlying processor; it does not act as a standalone card gateway. Card processing is configured per Cheddar account and billed automatically via the subscription endpoints.

Getcheddar Cheddar API

Connect the Cheddar API to your agent

Capabilities

Start building with Cheddar API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs