Pricing

Get customiser pricing

deprecated

Copy page

Retrieve all pricing configuration for a customiser. The pricing_model value is the internal enum name for the customiser's pricing model.

GET/api/v2/customisers/{customiser}/pricing

Get customiser pricing

Retrieve all pricing configuration for a customiser. The `pricing_model` value is the internal enum name for the customiser's pricing model. The current product names are: `FIXED_WIDTH` is the Simple Letter Model, `MATERIAL_LENGTH` is the Advanced Letter Model, and `FRAME_FIT` is the Frame Fit Model. `FIXED_HEIGHT` is the deprecated legacy Fixed Height Model and is rejected with a 422 — the supported fixed-height sizing path is the Simple Letter Model (`FIXED_WIDTH`) with a `HEIGHT` height strategy on its sizes. Error responses always include a human-readable `message` field. Validation failures also include an `errors` object keyed by field path.

Get customiser pricing

Click Send to see the live response.

Overview

The current product names are: FIXED_WIDTH is the Simple Letter Model, MATERIAL_LENGTH is the Advanced Letter Model, and FRAME_FIT is the Frame Fit Model. FIXED_HEIGHT is the deprecated legacy Fixed Height Model and is rejected with a 422 — the supported fixed-height sizing path is the Simple Letter Model (FIXED_WIDTH) with a HEIGHT height strategy on its sizes. Error responses always include a human-readable message field. Validation failures also include an errors object keyed by field path.

Authorisation

Bearer token required. Include it in the Authorization header.

Path parameters

customiserstringpathrequired

The customiser ID.

Example: 1

Get customiser pricing

curl https://web.signcustomiser.com/api/v2/customisers/1/pricing \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

{
  "pricing": {
    "customiser_id": 1,
    "pricing_model": "FIXED_WIDTH",
    "value_units": {
      "base_price": "minor_currency_units",
      "letter_price": "minor_currency_units",
      "letter_price_by_position": "minor_currency_units",
      "price_per_letter": "minor_currency_units",
      "price_per_letter_by_position": "minor_currency_units",
      "price_per_cm": "currency_units_per_cm",
      "price_per_sq_cm": "currency_units_per_sq_cm_or_weight_unit"
    },
    "sizes": [],
    "base_pricing": {
      "mode": "included_in_price_lists",
      "rows": []
    },
    "price_lists": []
  }
}

{
  "message": ""
}

{
  "message": "This action is unauthorized."
}

{
  "message": "No query results for model [App\\Models\\Customiser] 1"
}

{
  "message": "FIXED_HEIGHT pricing is not supported by this endpoint."
}