Skip to main content
The generated endpoint pages contain the exact filters and response schemas for these Merchant API operations.

​
Products

List products

Search and filter the organization catalog.

Create a product

Create one product with one price.

Get a product

Read one product by its Anyway ID.

Update a product

Change a product’s name or description.

Archive a product

Stop a published product from taking payments.

Publish a product

Put an archived product back on sale.

Get product payment links

List the customer-facing Anyway links configured for a product.

Create a payment link

Add a price and a shareable payment link to an existing product.

Update a payment link

Change a payment link’s title, description or success URL.

​
Subscription records

List subscriptions

Filter and paginate recorded subscriptions.

Get a subscription

Inspect lifecycle, customer, product, and billing data.
Use these operations to inspect subscription records and their lifecycle data. The list accepts status and customer_id. A subscription response includes its stable subscriptionId, customer and product, DAY, MONTH, or YEAR billing interval, current period end, scheduled-cancellation state, and initial/latest order IDs when those relationships exist. These Merchant API operations are read-only; schedule cancellation from the authenticated Business app, or let buyers cancel from the self-service link in their subscription email.

​
Customers

List customers

Read customers derived from commerce records.

Get a customer

Inspect one derived customer identity.
Customers are derived from the organization’s order history. A customer record contains its stable customerId and normalized email. To load related commerce records, filter orders and subscriptions with that customer_id.

​
Entitlements

Check entitlement

Resolve access using an email, wallet, or customer identity, optionally scoped to a product.
An entitlement response describes current access; it is not a substitute for authenticating the person making the request. Match the resolved identity to your own authenticated user before granting content or service access.