Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.shakesco.com/llms.txt

Use this file to discover all available pages before exploring further.

For the complete documentation index, see llms.txt. The Payments API (https://payments.shakesco.com) gives your backend full programmatic control over invoices, customer analytics, and store items. Use it to automate billing, build dashboards, or sync your catalogue.
All API calls require your API key. Get it from users.shakesco.com/user/api-tokens.

Invoices

Create invoices and generate a payment URL in one call:
const res = await fetch("https://payments.shakesco.com/invoices", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    type: "public",
    currency: "USD",
    payer_email: "customer@example.com",
    items: [{ description: "Consulting", unit: 5, price: 100 }],
  }),
});

const { invoice_number, payment_url } = await res.json();
// Share payment_url with your customer
Other invoice operations:
MethodEndpointDescription
GET/invoicesList all invoices
GET/invoices/:numberGet a single invoice
GET/invoices/payer/:emailInvoices for a customer
POST/invoices/:number/voidCancel an invoice

Full Invoice API

Complete parameter reference and response shapes

Analytics

Pull per-customer payment data into your own dashboards:
const email = encodeURIComponent("customer@example.com");
const res = await fetch(
  `https://payments.shakesco.com/analytics/customer/${email}`,
  { headers: { Authorization: `Bearer ${API_KEY}` } }
);
const { overview, revenue, recent_transactions } = await res.json();

Analytics API Reference

Full analytics endpoint documentation

Store Items

Fetch your store catalogue programmatically:
// Browse all items for a business
const res = await fetch("https://payments.shakesco.com/store/user/42?page=1", {
  headers: { Authorization: `Bearer ${API_KEY}` },
});
const { data } = await res.json();

// Get a single item
const item = await fetch("https://payments.shakesco.com/store/101", {
  headers: { Authorization: `Bearer ${API_KEY}` },
}).then(r => r.json());

Store API Reference

Full store endpoint documentation

Currency Codes

All currency codes used in invoices and analytics:
const res = await fetch("https://payments.shakesco.com/codes", {
  headers: { Authorization: `Bearer ${API_KEY}` },
});
const { currency_codes } = await res.json();

Currency Codes

List of all 300+ supported currency codes