Payments

The Payments API gives you programmatic access to the payment records in your SMBcrm account: orders, transactions, subscriptions, products & prices, coupons, and invoices & estimates. Use it to read what’s already happened, manage your catalog, and issue billing documents without leaving your own systems.

Payment providers are set up in the app

Connecting or configuring a payment gateway/provider for your account is done in the SMBcrm app UI, not through this API. Nothing in this section walks you through that setup. These endpoints only read and manage the records a connected provider produces: orders, transactions, invoices, and so on.

What you can do here

• Orders & Transactions: list the orders placed in your account and drill into the transactions behind them.
• Subscriptions: read the recurring billing set up for your contacts.
• Products & Prices: manage your product catalog and the one-time or recurring prices attached to each product.
• Coupons: create, update, and look up discount codes.
• Invoices & Estimates: create, send, and track one-off billing documents.

Each resource has its own reference page with the exact request and response shapes. See In this section below.

Authentication & scopes

Every payments endpoint uses the same request shape as the rest of the API: a Location token or PIT in the Authorization header, plus the Version header. See Base URL & Headers if you haven’t made a request yet.

Request only the scopes your integration actually needs:

Scope	Grants
payments/orders.readonly	Read orders
payments/transactions.readonly	Read transactions
payments/subscriptions.readonly	Read subscriptions
payments/coupons.readonly	Read coupons
payments/coupons.write	Create, update, and delete coupons
products.readonly	Read products
products.write	Create, update, and delete products
products/prices.readonly	Read prices
products/prices.write	Create, update, and delete prices
invoices.readonly	Read invoices and estimates
invoices.write	Create, update, and delete invoices and estimates

See Scopes for how scopes are requested and enforced.

The altId / altType convention

Invoices and some other payments endpoints identify your account with a pair of query parameters instead of, or in addition to, locationId:

• altId: your <location_id>
• altType: always location

curl "https://services.smbcrm.com/invoices/?altId=<location_id>&altType=location" \
  -H "Authorization: Bearer <token>" \
  -H "Version: v3"

Tip

Whenever an endpoint’s reference page shows altId/altType, use them exactly like this: altId is always your own account/location ID, and altType is always location.

In this section

Orders & TransactionsOrders placed in your account and the transactions behind them.

SubscriptionsRecurring billing tied to a contact and a price.

Products & PricesYour product catalog and the prices attached to it.

CouponsDiscount codes you can create, update, and look up.

Invoices & EstimatesOne-off billing documents you create and send to a contact.

Related

• Scopes: request the narrowest set of payments scopes your integration needs.
• Contacts: orders, subscriptions, and invoices are all tied to a contact.
• Webhooks: subscribe to payment events instead of polling for changes.