Upgrades Endpoint

For full field documentation, see the Upgrade entity.

Upgrades are read-only via the API - they must be configured in the FFF admin interface.

Endpoints

List Upgrades

GET /api/f1/sync/upgrades

Returns a list of all upgrades configured for your dropzone.

Response

{
  "version": "1.0.0",
  "upgrades": [
    {
      "id": 1,
      "name": "Add Video & Photos",
      "active": true,
      "stripe_price_cents": 12000,
      "stripe_price_currency": "GBP"
    }
  ]
}

(some fields omitted for brevity)

Get Upgrade

GET /api/f1/sync/upgrades/:id

Retrieves a specific upgrade by ID.

Response

{
  "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"
}

(some fields omitted for brevity - see Upgrade entity for full field list)

Notes

  • Pricing is managed through Stripe - the stripe_price_identifier must be a valid Stripe Price ID
  • Upgrades are offered to customers based on what their current product entitles them to