Customers
A customer is the entity that purchases goods or services from a merchant. A customer may be a person or an organization. Every customer has a unique id referenced from other resources as customerId.
Invoices
An invoice is a commercial document issued by a merchant to a customer for products or services. In PaymentsAI an invoice is generated by an order and tracks the lifecycle of one specific charge — typically a single subscription renewal or a one-time order.
Orders
16 items
Organizations
An Organization is the top-level entity in PaymentsAI. It represents you, or your company, as a merchant. When you first sign in to PaymentsAI you are prompted to create one. Every API call addresses an Organization explicitly through organizationId in the URL path or header.
Payment instrument lifecycle
A payment instrument moves through a defined set of states. The state decides whether PaymentsAI can auto-charge it.
Payment instruments
A payment instrument is any way a customer makes a digital payment: credit card, debit card, direct debit, payment service provider (PayPal and similar), or digital wallet (Apple Pay, Google Pay).
Pricing
A product could have different pricing depending on the plan. You could choose from 5 groups of pricing when setting up this property.
Products and plans
Products and plans together define what the customer is buying and how they are charged for it. A product is the thing being sold; a plan is the pricing template applied to that product.
Recurring interval
recurringInterval is the field on a plan that defines when a subscription renews and how often. A plan with recurringInterval is a subscription plan; a plan without it is a one-time plan.
Refunds
A refund returns funds to the customer for a transaction that has already been captured. You can refund either the full amount or a partial amount. For step-by-step instructions, see Refund a transaction.
Transaction statuses
A transaction has three independent fields that together describe its state and outcome: status, result, and type. PaymentsAI also exposes a combinedStatus field that merges status and result into a single value for display.
Transactions
A transaction is an instance of an action that requires a payment. Every charge, authorization, refund, and card verification on Payments AI is a transaction.
Trial
A trial is a free or reduced-price period at the start of a subscription. You configure it on the plan, and it applies whenever a subscription is created against that plan.