Back to showcase

Markdown Typography

Demonstrates how all markdown elements render inside the .api-layout prose container. This is the styling applied to all documentation pages.

Headings

Heading 1

Heading 2

Heading 3

Heading 4


Paragraphs & Inline Styles

This is a standard paragraph with bold text, italic text, and inline code. You can also combine them: bold italic.

Here is a paragraph with a internal link and an external link. Links inside prose inherit the accent color and underline on hover.


Lists

Unordered List

  • First item
  • Second item with inline code
  • Third item
    • Nested item A
    • Nested item B
  • Fourth item

Ordered List

  1. Create your API key in the dashboard
  2. Install the SDK
    1. Run npm install @aress/sdk
    2. Import and configure the client
  3. Make your first request
  4. Handle the response

Tables

ParameterTypeRequiredDescription
idstringYesUnique identifier for the resource
emailstringYesCustomer email address
namestringNoDisplay name for the customer
metadataobjectNoArbitrary key-value pairs attached to the resource

Code Blocks

Code blocks use the CodeBlock component with optional title and language.

Example request
const response = await fetch('/api/v1/customers', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer sk_test_xxx'
  },
  body: JSON.stringify({
    email: 'jane@example.com',
    name: 'Jane Doe'
  })
});

const customer = await response.json();
Example response
{
  "id": "cus_abc123",
  "email": "jane@example.com",
  "name": "Jane Doe",
  "created_at": "2025-01-15T09:30:00Z"
}
curl -X GET https://api.example.com/v1/customers \\\n  -H 'Authorization: Bearer sk_test_xxx'

Blockquotes

This is a standard blockquote. It can contain bold, italic, and inline code.

Callout Variants

Callouts are styled blockquotes with type annotations. Four variants are available:

Info
This endpoint requires authentication with a valid API key.
Tip
Use idempotency keys to safely retry requests without creating duplicates.
Warning
This parameter is deprecated and will be removed in API version 2025-06-01.
Error
The response format has changed. See the migration guide for details.

Horizontal Rules

Horizontal rules create visual separation between sections:


Content continues after the rule.


Combined Example

When building an integration, start by creating an API key in the dashboard. Then install the SDK:

npm install @aress/sdk
Note
The SDK requires Node.js 18 or later.

Configure the client with your credentials:

Setup
import { AressClient } from '@aress/sdk';

const client = new AressClient({
  apiKey: process.env.ARESS_API_KEY,
  environment: 'sandbox'
});

Then list your customers:

  1. Call client.customers.list() to fetch all customers
  2. Use limit and offset for pagination
  3. Filter by email or created_at range
StatusMeaning
200Success
401Invalid or missing API key
429Rate limit exceeded