public-api-docs

User API Commercial Products Guide

Overview

Commercial products in the User API are split across several product surfaces. Packages, subscriptions, rate plans, vouchers, promotions, balances, and calculators each deserve their own flow because they answer different user questions.

Use this page as an index. For implementation details, start with the guide for the product surface you are building.

Related reference: User API User API Guide Payments And Invoices Guide

Product Guides

Product area Guide Use it for
Packages User API Packages Guide Package catalog, package pricing, package purchase, package-created benefits.
Subscriptions and rate plans User API Subscriptions And Rate Plans Guide Subscription catalog, owned subscriptions, renewal/cancel/switch, pricing bundle calculators.
Vouchers and promotions User API Vouchers And Promotions Guide Voucher wallet, voucher-code redemption, selected-vehicle voucher display, geofence promotions and surcharges.
Wallet, balances, and pricing User API Wallet, Balances, And Pricing Guide Wallet display, money/minutes balances, balance history, shared balances, invoice/payment links, pricing calculators.

Most Relevant APIs

Area Endpoints
Packages GET /packages, GET /packages/{packageCode}/pricing, POST /packages/buy
Subscriptions GET /subscriptions, GET /subscriptions/{subscriptionCode}, POST /subscriptions/buy/{subscriptionCode}, POST /subscriptions/cancel/{subscriptionCode}, POST /subscriptions/reactivate/{subscriptionCode}, POST /subscriptions/renew/{subscriptionCode}
User subscriptions GET /user-subscriptions, GET /user-subscriptions/{id}, DELETE /user-subscriptions/{id}, POST /user-subscriptions/{id}/switch
Vouchers and promotions GET /vouchers, POST /vouchers/redeem-code, GET /promotions
Wallet and balances GET /balances, POST /balances, DELETE /balances/{id}, POST /balances/{id}/default, GET /balances/{balanceId}/history, GET/POST /balances/{balanceId}/users, DELETE /balances/{balanceId}/users/{referralCode}
Pricing calculators GET /pricing-bundles/pricing-calculator, GET /pricing-bundles/pricing-simulator, GET /booking-price-calculator

Implementation Notes