Upgrade Entity

Upgrades are purchasable add-ons that customers can buy to enhance their content package after their initial booking.

Fields

Field Type Required Description
id integer Yes Unique identifier for the upgrade
name string Yes Display name for the upgrade
active boolean Yes Whether the upgrade is currently available for purchase
notify_staff boolean Yes Whether staff should be notified when this upgrade is purchased
stripe_price_cents integer No Price in cents (fetched from Stripe)
stripe_price_currency string No Currency code (e.g., GBP, USD)
stripe_price_identifier string No Stripe Price ID (format: price_xxx)
created_at datetime Yes When the upgrade was created
updated_at datetime Yes When the upgrade was last updated

Example

{
  "id": 1,
  "name": "Add Video & Photos",
  "active": true,
  "notify_staff": true,
  "stripe_price_cents": 12000,
  "stripe_price_currency": "GBP",
  "stripe_price_identifier": "price_1ABC123def456",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Notes

  • Pricing is managed through Stripe - the stripe_price_identifier must be a valid Stripe Price ID
  • Price information (stripe_price_cents, stripe_price_currency) is fetched automatically from Stripe
  • Upgrades are offered to customers based on what their current product entitles them to
  • Upgrades are read-only via the API - they must be configured in the FFF admin interface