For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
LogoLogo
Log inGet Paid
DocumentationAPI Reference
DocumentationAPI Reference
  • Introduction
    • Overview
  • API Reference
  • Overview
  • List customers
  • Create a new customer
  • Get customer by ID
  • Update customer
  • Delete customer
  • Check customer entitlement for an event
  • Get customer entitlements
  • Get customer by external ID
  • Update customer by external ID
  • Delete customer by external ID
  • Fetch cost traces for a customer by external ID
  • Fetch usage summaries for a customer by external ID
  • List customer payment methods by external ID
  • Create customer payment method by external ID
  • Delete customer payment method by external ID
  • List agents
  • Create Agent
  • Get agent by ID
  • Update Agent
  • Delete agent
  • Get agent by external ID
  • Update agent by external ID
  • Delete agent by external ID
  • List products
  • Create product
  • Get product by ID
  • Update product
  • Delete product
  • Get product by external ID
  • Update product by external ID
  • Delete product by external ID
  • Get contacts
  • Create contact
  • Get contact by ID
  • Delete contact
  • Get contact by external ID
  • Delete contact by external ID
  • List orders
  • Create order
  • Get order by ID
  • Delete order
  • Activate order
  • Activate order and process payment
  • Cancel order renewal
  • Schedule a plan change with proration
  • Get invoices for an order
  • Update order lines
  • Get customer's current plan
  • Get plan by ID
  • Fetch usage summaries for a plan and customer
  • Subscribe customer to plan
  • Unsubscribe customer from plan
  • Upgrade customer to a new plan
  • Get plan group by ID
  • Get plans for a plan group
  • Record usage signals in bulk
  • Record usage signals in bulk (V2 - Clean field names)
  • Check if usage is allowed for a customer and product
  • Fetch cost traces for an organization
Log inGet Paid
Introduction

Overview

Paid is the all-in-one, drop-in Business Engine for AI Agents that handles your pricing, subscriptions, margins, billing, and renewals with just 5 lines of code.

The Paid platform can be accessed through the API or through our SDKs.

TypeScript
Python
Go
Ruby
Java
Was this page helpful?

List customers

Next
Built with