Changelog

All notable changes to this project will be documented in this file.

[1.3.2] - 2026-01-22

Added

• Brand Support: New custom_branding field for booking requests and responses
  • Allows partners to set a specific visual style for the app experience
  • Brand identifier must correspond to a configuration that exists in the Hubby platform
  • Contact support to set up custom branding for your organization
• Departure Location: New departure_location field for booking requests and responses
  • Capture where travelers are departing from (airport code, city name, or address)
  • Provides additional context for the booking

[1.3.1] - 2025-10-27

Added

• Promo Code Claiming: New feature to share claim links instead of promo codes directly
  • Added uuid and claim_url fields to promo code responses
  • New public endpoint POST /api/promo-codes/claim/{uuid} for claiming promo codes with email capture
  • Claim URLs are only included when bookings don't have an email address
  • Immediate email delivery of promo codes upon claiming
  • Perfect for events, marketing campaigns, and lead capture
• Promo Code Retrieval: New endpoint GET /api/promo-codes/{id} for retrieving promo code details
  • Partners can fetch their promo codes with full metadata
  • Includes RBAC authorization for organization-level access control
• Enhanced Promo Code Documentation: Added comprehensive guide on promo code claiming feature

Changed

• Promo code response schema now includes additional metadata fields: iso3, package_type, package_duration, and traffic_policy

[1.3.0] - 2025-07-27

Added

• Package Type Support: Added support for multiple package types in booking requests
  • package_type parameter with options: starter, data-limited, unlimited, time-limited
  • package_duration parameter to specify package duration in days
  • Default values: data-limited for package type, 365 days for data-limited packages, 2 days for starter and time-limited packages
• Enhanced Package Documentation: Added comprehensive documentation explaining the differences between package types
  • Starter packages: Small data allowance for short duration, ideal for trials (default: 2 days)
  • Data-limited packages: Traditional packages with specific data allowance (default: 365 days)
  • Unlimited packages: Unrestricted data usage with fair use policy
  • Time-limited packages: Fixed data allowance with time constraint for full-speed access
  • Clarification that top-ups are always data-limited packages

Changed

• API Version: Bumped the version to v1.3.0
• Default Package Type: Data-limited packages are now the primary focus and default option

[1.2.0] - 2025-05-12

Added

• Endpoints added for in app integration The first endpoints for in-app integration have been added.
• External ID Support: Added optional external_id property to bookings for better integration with external systems.

Changed

• Destinationless bookings A booking no longer requires a destination to be specified, the destination can now be picked by the end user.
• Bumped the version to v1.2.0

[1.1.0] - 2025-03-16

Added

• HMAC Auth: HMAC Authentication is now the default for this API
• Regen promo codes: Added the option to regenerate codes.

Changed

• Enhanced Entity Details: All models now includes additional metadata fields, such as created_by and updated_at, to provide better context for each..

Fixed

• Time Format Consistency: Standardized all time-related fields to use ISO 8601 format, ensuring consistency across the API.

[1.0.0] - 2023-02-15

Initial Release

• Launched the Hubby eSIM API with core features including creating a booking and fetching packages.