Object Relationships
Core Objects
User
Customers who purchase from your store. Contains contact and billing information.
Product
Items you sell - games, subscriptions, digital downloads, etc.
Offer
Pricing configurations for products with region/currency support.
Discount
Price reductions via coupon codes or automatic sales.
Order
Purchase transactions containing items, totals, and status.
Payment
Financial transactions with charges and payment method details.
Subscription
Recurring billing relationships for subscription products.
Event
Webhook notifications about activity in your store.
Common Flows
One-Time Purchase Flow
Subscription Flow
Refund Flow
Subscription Lifecycle
Object Hierarchy
Catalog Structure
A Product is the top-level catalog item. Products can have:- Variants - Different versions (Standard, Deluxe, Ultimate editions)
- Plans - Subscription billing options (Monthly, Annual)
- Offers - Pricing per region/currency
Transaction Hierarchy
Each customer action creates linked transaction objects:ID Formats
| Object | Format | Example |
|---|---|---|
| User | UUID | 123e4567-e89b-12d3-a456-426614174000 |
| Product | UUID | bb0e8400-e29b-41d4-a716-446655440006 |
| Offer | UUID | 990e8400-e29b-41d4-a716-446655440004 |
| Discount | UUID | 880e8400-e29b-41d4-a716-446655440003 |
| Order | UUID | 550e8400-e29b-41d4-a716-446655440000 |
| Order Number | String | #ABC123DEF456 |
| Payment | UUID | 660e8400-e29b-41d4-a716-446655440001 |
| Subscription | String | #SUB123DEF456 (based on order number) |
| Event | UUID | evt_123e4567-e89b-12d3-a456-426614174000 |
Order numbers and subscription IDs are human-readable strings prefixed with
#. These can be used interchangeably with UUIDs in most API endpoints.Webhook Events by Object
| Object | Events |
|---|---|
| Payment | payment_success, payment_failed, payment_refunded |
| Subscription | subscription_created, subscription_updated, subscription_interval, subscription_cancelled |
data payload:
data.order- The Orderdata.payment- The Paymentdata.customer- The Userdata.items- Array of purchased items with Product and Offer references
Next Steps
Webhooks Setup
Configure endpoints to receive events
API Authentication
Get your API keys and authenticate