An endpoint reference card: method and path with highlighted parameters, auth, grouped parameter lists, and request and response examples in tabs with copy.
Starts a subscription for an existing customer. The first invoice is created immediately unless a trial is set.
Bearer token
Path parameters
account_idstringrequiredThe customer's account ID.
Query parameters
dry_runbooleanValidate the request without creating anything. Default:
false
Body
planstringrequiredPlan identifier, such as team_monthly.
trial_daysintegerFree days before the first charge.
{ "plan": "team_monthly", "trial_days": 14}The source is part of Ballmac UI Pro.
Log in with your licence key to read and copy it here, or install it through the shadcn CLI or the MCP server. You own the code once it is in your project.
$49 once regular price $99for this and every other Pro item. Tax included.Money back if it does not work.
Installation
Get a Pro licence key.
The source is part of Ballmac UI Pro.
Log in with your licence key to read and copy it here, or install it through the shadcn CLI or the MCP server. You own the code once it is in your project.
$49 once
regular price $99for this and every other Pro item. Tax included.Money back if it does not work.Once per project: add the Pro registry and your licence key.
components.json{ "registries": { "@ballmac": "https://ui.ballmac.com/r/{name}.json", "@ballmac-pro": { "url": "https://ui.ballmac.com/r/pro/{name}.json", "headers": { "Authorization": "Bearer ${BALLMAC_LICENSE_KEY}" } } } }.env.localBALLMAC_LICENSE_KEY=your-licence-keyAdd it.
$ pnpm dlx shadcn@latest add @ballmac-pro/api-endpoint
Usage
import { ApiEndpoint } from "@/components/ballmac/api-endpoint"The full example is in the Code tab above.
Examples
A stack of endpoints
The source is part of Ballmac UI Pro.
Log in with your licence key to read and copy it here, or install it through the shadcn CLI or the MCP server. You own the code once it is in your project.
$49 once regular price $99for this and every other Pro item. Tax included.Money back if it does not work.
API reference
| Prop | Type | Default |
|---|---|---|
method*HTTP method. | HttpMethod | — |
path*Path, with `{name}` for path parameters. | string | — |
summary*Short name of the operation, such as "Create a customer". | string | — |
descriptionLonger explanation. | string | — |
baseUrlBase URL used by the "Copy URL" button. | string | — |
authAuthentication needed, such as "Bearer token". Shown as a lock chip. | string | — |
parametersRequest fields. | EndpointParameter[] | [] |
requestExampleExample request body. | string | — |
requestLanguageHighlighter for the request body. | HighlightLanguage | "json" |
responsesPossible responses. | EndpointResponse[] | [] |
defaultOpenOpen at first. | boolean | true |
openControlled open state. | boolean | — |
onOpenChangeCalled when the card opens or closes. | (open: boolean) => void | — |
Also accepts the standard attributes of its root element.
Accessibility
| Key | Action |
|---|---|
| Enter / Space | Opens or closes the card |
| ArrowLeft / ArrowRight | Moves between Request and response tabs |
| Screen readers | Parameters are grouped lists; each example is a labelled region; status tabs say Success or error class |
Quality scorecard
Every applicable check passes
Measured in Chromium 153.0.8010.12 on October 19, 2026, on version 1.0.0, across 2 examples.
Passed: Accessibility scan
No serious or critical issues in light and dark, on a phone and a desktop (axe-core 4.13.0, WCAG 2.1 AA and best-practice rules).
Passed: Small screens
No sideways scrolling at 360, 390 or 1280 px wide.
Passed: Reduced motion
No endless animation to begin with.
Not applicable: Right to left
Not mirrored by design: URLs, parameters and JSON are left to right inside by design.
Passed: Clean console
No console errors or React hydration errors while loading.
Passed: Keyboard
14 tab stops, each showing a visible change when it takes focus. 3 documented keys.
Not applicable: Loading, empty and error
Does not show data or take submissions.
Passed: Automated tests
Covered by api-endpoint.test.tsx.
For information: Footprint
3.6 KB of source (gzip) in 1 file. Installs lucide-react, radix-ui.
Automated checks find a subset of problems and do not replace testing with a screen reader and a keyboard in your own app. What they miss.
Use with AI
method, path (use {id} for path parameters), summary, description, auth, parameters [{ name, in, type, required, description }], requestExample and responses [{ status, description, example }]. Collapsible; copies the full URL when baseUrl is set. With the shadcn MCP server set up (guide), ask your agent:
Add the Ballmac UI API Endpoint (@ballmac-pro/api-endpoint) to this project with the shadcn MCP, then use it where it fits.
Use it for
- Hand-written API reference pages
- Internal docs for a small API
Not for
- Generating a full OpenAPI portal (render from the spec with your own loop over this component)
Registry JSON (needs your licence key): https://ui.ballmac.com/r/pro/api-endpoint.json
Credits
Covered by the Ballmac UI Pro license.
Pairs well with
Snippet Tabs
Request examples in several languages with built-in highlighting, a remembered language choice shared across the page, line numbers, copy, and {{variables}} filled with real values.
Code Block
A code panel with filename and language header, line numbers, highlighted lines, a wrap toggle, copy feedback and file tabs. No highlighter bundled; pass Shiki output as children.
JSON Viewer
A collapsible JSON inspector with compact type styling and keyboard-operable branches.
API Key Field
Displays a secret such as an API key, masked by default (sk-live-••••••••a1b2), with a reveal toggle, a copy button that copies the full key, and an optional regenerate action.