ProductOSDocs

Entity reference · v1

pricing

PRC-NNNNNNtable pricing_tierssoft delete

Pricing tiers.

Endpoints

GET/api/v1/pricing
POST/api/v1/pricing
GET/api/v1/pricing/{id}
PATCH/api/v1/pricing/{id}
DELETE/api/v1/pricing/{id}
POST/api/v1/pricing/{id}/restore

Writable fields

* required on create. PATCH treats every field as optional.

FieldTypeConstraintsNotes
name*string
descriptiontext
pricefloat
billing_periodstringmonthly | annual | one-time
featuresjson
target_segmentstring
is_recommendedboolean
competitor_pricingjson
sort_orderinteger
is_draftboolean
metadatajson

Listing & filtering

  • Pagination: ?limit=50&offset=0 · max limit 200
  • Default sort: ?sort=sort_order&order=asc
  • Sortable fields: created_at · updated_at · sort_order · price · id_number
  • Search (?q=): name, description
  • Filters: ?billing_period= ?target_segment= ?is_recommended= , repeat any filter to OR multiple values
  • Trash: hidden by default; pass ?include_deleted=true

Examples

curlbash
curl 'https://productos.ca/api/v1/pricing?limit=10' \
  -H "Authorization: Bearer $TOKEN"

Try it out

Paste a token and hit a real endpoint. The request goes from your browser straight to /api/v1/pricing. The token is held in this page only for the request and is never stored.

Try it out

Issue tokens in Settings → API tokens. Token never leaves this page.

GET/api/v1/pricing?limit=3

Generated from the API's entity configuration. This page is rebuilt on every deploy, so it always matches the live API.