TransactKit-Prov1.0.0
TransactKit-Pro API reference
Reference the shipped TransactKit-Pro configuration, Customer, payment, refund, catalogue, subscription, Portal, invoice, Entitlement, usage, and webhook endpoints.
Updated
API conventions
TransactKit-Pro does not add authentication or authorization. Protect every application operation in the integrating host and bind Stripe and local identifiers to the authenticated account or tenant.
- Errors use RFC 9457 ProblemDetail.
- Validation failures return 400; missing resources 404; lifecycle or ownership conflicts 409.
- Stripe rate limiting maps to 429; missing configuration and upstream failures map to controlled 502 or 503 responses.
- List responses contain items, hasMore, and nextCursor; limits default to 20 and allow 1-100.
Operations and Customers
| Method | Path | Purpose |
|---|---|---|
| GET | /api/configuration | Return safe Stripe API and webhook configuration booleans |
| GET | /actuator/health | Read health and liveness/readiness state |
| GET | /actuator/info | Read application information |
| POST | /api/customers | Create a Stripe Customer; no local Customer row |
| GET | /api/customers/{id} | Retrieve an authoritative Stripe Customer |
Payments, refunds, and catalogue
| Method | Path | Purpose |
|---|---|---|
| POST | /api/checkout/sessions | Create or reuse hosted one-time Checkout |
| GET | /api/payments/{id} | Read the local Payment projection |
| POST | /api/payments/{id}/refund | Create a full or partial Stripe Refund |
| GET | /api/refunds/{id} | Retrieve an authoritative Stripe Refund |
| GET | /api/catalog/products | List Stripe Products with cursor pagination |
| GET | /api/catalog/products/{id} | Retrieve a Stripe Product |
| GET | /api/catalog/prices | List Stripe Prices with optional Product and active filters |
| GET | /api/catalog/prices/{id} | Retrieve a Stripe Price |
Subscriptions
| Method | Path | Purpose |
|---|---|---|
| POST | /api/subscriptions/checkout-sessions | Create or reuse hosted subscription Checkout |
| GET | /api/subscriptions/{id} | Refresh and return one managed subscription |
| GET | /api/customers/{customerId}/subscriptions | Page locally managed subscriptions for one Customer |
| POST | /api/subscriptions/{id}/change | Change the managed Price, quantity, or both |
| POST | /api/subscriptions/{id}/cancel | Cancel immediately or at period end |
| POST | /api/subscriptions/{id}/reactivate | Reverse a scheduled cancellation |
Portal, invoices, Entitlements, and usage
| Method | Path | Purpose |
|---|---|---|
| POST | /api/billing/portal/sessions | Create a Customer Portal Session |
| GET | /api/invoices/{id} | Retrieve an authoritative Stripe Invoice |
| GET | /api/customers/{customerId}/invoices | List Customer invoices, optionally by subscription |
| GET | /api/customers/{customerId}/entitlements | Rebuild and return active Entitlements |
| POST | /api/billing/usage | Create a stable Stripe Billing Meter Event |
| POST | /api/stripe/webhook | Verify and process a Stripe event |