Changelog

​

Breaking Changes

​

New Base URL

​

API Key Changes

sk_v3_vTUkUBKIDblpPUXKbTEmqIdgpngsvhvX

​

Available Endpoints

• /payments
• /storefront
• /orders
• /coupons
• /products
  • /licenses (only available if you use managed licenses)
• /customers

​

Webhooks

{
  "id": "wh_",
  "type": "payment.succeeded",
  "data": {
    "id": "pmnt_",
    "amount": 1000,
    "status": "succeeded"
  }
}

​

Features

• Introduced stricter moderation policies for specific categories.
• Enhanced support for moderation on multiple types of content.
• Added support for applying coupons during checkout.
• Enhanced validation and error handling for smoother payment experiences.
• Introduced support for additional currencies, including EUR for European customers.
• New schema improvements to support advanced use cases.
• Added features for guest and authenticated customer management.
• Improved session management and user lifecycle handling.

​

Fixes

• Resolved issues with file validation and error handling during uploads.
• Improved the accuracy of category and slug validations.
• Addressed bugs in session retrieval and pagination.

​

Performance

• Enhanced database performance with optimized queries.
• Improved system efficiency by reducing unnecessary computations.

​

Other

• Refactored several internal services for better maintainability.

​

New Properties

• tax_calculation_enabled
• localized_pricing_enabled
• regional_pricing_enabled
• checkout_collect_phone_enabled
• checkout_verify_email_enabled
• plan

​

Endpoints Affected

• /shops
• /shops/flags
• /products
• /categories
• /coupons

​

Renamed Property

• cash_app has been renamed to cashapp in the PaymentMethod[] flag object.

​

Added Payment Methods

• venmo
• paypal
• multiple_cards (supporting Visa, MasterCard, etc.)

​

Removed Property

• stripe_connect has been removed from the Flag object.

​

Products

• Added images[{ id, hash, path, preview_url, resolution }] to Product[] and the Product object.
• Added categories[] to Product[] and the Product object.

​

Shops

• Added icon_url to Shop[] and the Shop object.

​

Pagination

• page_size: 10
• page: 1

​

Filtering and Sorting

• filter (Applies filters to the query using defined operators)
  • Operators: eq, ne, gt, gte, lt, lte, in, nin, contains.
• sort (Defines the sorting criteria for the results)
• search (A search term that looks for matches)

• Fixed bugs with File API.
• Advanced sorting and filtering capabilities for the following endpoints:
  • /products
  • /categories
  • /coupons
• Beta support for subscriptions.
• Beta support for new serial keys.
• Performance enhancements across the API.

​

New Features

• MoR Model: Introduced an optional MoR model for users who wish to opt in.
• Advanced Analytics: Added support for advanced analytics.
• Dynamic Payments: Implemented support for dynamic payments.
• Idempotency Support: Added idempotency support for POST, PUT, and PATCH requests.
• Payments Endpoint: Launched a new /payments endpoint to support finite-based payments.
• Intent-Based Flags: Introduced new intent-based flags.
• File API: Added a new intent-based file API at /files.

​

Updated Endpoints

• /shops
• /products
• /categories
• /coupons
• /orders
• /refunds
• /disputes
• /carts
• /webhooks

• Added new /public endpoints with multiple options for filtering.
• Added new /onboarding and /login endpoints.
• Deprecated support for transactions[] and replaced with payment[].
• Added flags to shops.

• Added /{shopId}/carts to initiate a new cart.
• Added cartId? optional param to order intent creation object.

​

Added

• /categories route with support for listing categories, creating, getting, deleting, and updating.
• categories field to the product model.

​

Changed

• POST /products: Now returns { product: { ... } } instead of directly returning the product object.
• GET /products: Now returns { products: [{ ... }] } instead of directly returning the product list.
• GET /products/{id}: Now returns { product: { ... } } instead of directly returning the product object.

​

Changed

• Renamed shop route to shops.

​

Added

• payout route with support for page and pageSize parameters.
• recipients route for adding payout information.
• flags.requirements.payouts and flags.requirements.kyc{status, checked_at} to the /user object.
• customer route with support for auth tokens of types ["login", "register", "token"] (action-based auth).
• Sending of payout emails.
• documents route for KYC-related tasks.

​

Removed

• paid_at attribute from the payout object.

​

Updated

• recipient.compliance.status added to /user.
• Successful API operations now return OK status instead of SUCCESS.
• Supported Stripe Express accounts.
• New health check message on /healthcheck route.
• image_hash returned on public endpoints.
• coupon.enabled added to coupons.
• payments route for payment flow creation.

​

Updated

• Event terminology from transaction to order object.
• The event type previously referred to as transaction has been standardized as order object. The associated identifier now returns as order.id.
• Renamed all transaction event types to order for consistency.

​

Added

• payment event type.
• New status events under payment:
  • payment.pending: Indicates a pending payment.
  • payment.paid: Denotes a successfully processed payment.
  • payment.success: Signifies a successfully completed payment transaction.
  • payment.failed: Indicates a failed payment transaction.

​

Added Properties

​

Account Object

• account["flags"]["verified"]
• account["flags"]["two_fa_enabled"]
• account["flags"]["deleted"]
• account["flags"]["requirements"]{"activated"}

​

Shop Object

• shop["analytics"]["total_sales"]
• shop["analytics"]["total_earned"]
• shop["analytics"]["pending_balance"]
• shop["analytics"]["dispute_rate"]
• shop["flags"]["statement_descriptor"]
• shop["flags"]["features"]["pmp_enabled"]
• shop["flags"]["features"]["chargeback_protection_enabled"]
• shop["flags"]["features"]["storefront_enabled"]
• shop["flags"]["features"]["checkout_api_enabled"]
• shop["flags"]["features"]["domain_enabled"]
• shop["flags"]["features"]["ssl_enabled"]
• shop["flags"]["connect"]{"id", "enabled", "type"}

​

Transaction Object

• transactions["fee"]
• transactions["early_fraud_warning"]

​

Order Object

• order["discounted"]
• order["discount_code"]
• order["customer"]["customer_id"]
• order["customer"]["shipping_address_id"]
• order["customer"]["billing_address_id"]

​

Order Item

• product["name"] as order_item["name"]
• product["id"] as order_item["product_id"]
• order_itemp["quantity"]

​

Refund Object

• refund["reason"]
• refund["status"]

​

Dispute Object

• dispute["dispute_id"]
• dispute["reason"]
• dispute["status"]
• dispute["method"]
• dispute["amount"]
• dispute["total_amount"]
• dispute["fee"]

​

Coupon Object

• coupon["name"]
• coupon["code"]
• coupon["type"]
• coupon["value"]
• coupon["limit"]
• coupon["limit_enabled"]

​

Address Objects

• address["state"] to the shipping_address and billing_address objects.
• analytics["dispute"] to the analytics object.

• General Team release

• Implemented support for sortBy.status, and sortBy.date query parameters in the List Orders route.