Skip to main content
GET
List subscriptions
Every field on this resource is camelCase on the wire, unlike Payment Links, Checkouts, Invoices, and Transactions (which are mostly snake_case with a few camelCase extras). See Naming convention.
The list is paged with limit and offset and can be narrowed by discountCode. It cannot be filtered by customer email or by payment link. Keep that mapping on your side from the first checkout.session.completed, which carries the subscription’s id in metadata.subscriptionId.

Payment Links

Create a type: "subscription" link to start selling recurring plans.

Customers

The buyer behind each subscription.

Authorizations

x-api-key
string
header
required

Your secret key, from app.agentaos.ai -> Settings -> Developers -> API Keys. The key's prefix is both its identity and its environment: sk_test_... (sandbox, free, no verification) or sk_live_... (real money, requires business verification). A missing or invalid key returns 401.

Query Parameters

limit
integer
default:20

Items per page. Capped server-side at 100.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of items to skip, for the next page.

Required range: x >= 0
discountCode
string

Only subscribers who redeemed this code. Case-insensitive.

Response

A page of subscriptions.

items
object[]
required
total
integer
required
hasMore
boolean
required
summary
object
required

Your MRR and active count over every active and trialing subscription (with discountCode, those that redeemed it), not only this page.