Documentation/Ajouter un prix
openapi.jsonOuvrir mon espace

Ajouter un prix

POST/v1/products/{id}/prices

Un prix par période proposée et par monnaie.

La période suit le type du produit. Un produit « open » n’a pas de prix : c’est le payeur qui décide.

Les en-têtes

Idempotency-KeytexteConseillée : rejouée, la même clé rend la première réponse au lieu de refaire le geste.

Ce qu’on envoie

Un corps JSON. Ce qui n’est pas requis peut être omis.

labelREQUIStexteCe que le client lit : « Mensuel », « À l’unité ».
amountREQUISentierLe prix.
currencytexteSans précision : la monnaie de l’espace.
periodREQUIS« one_time » · « month » · « quarter » · « year » · « usage »Celle que le type du produit accepte : « one_time » pour « one_time », « month », « quarter » ou « year » pour « subscription », « usage » pour « usage ».
unittexteRequis à l’usage : ce qui se compte, « heure », « Go », « appel ».
notetexteUne précision, pour vous ou pour le client.
activevrai ou fauxEn vente d’office.

La demande

bash
curl https://api.payiz.app/v1/products/prd_01j9xm2hp7t4wzq6vc3k/prices \
  -H "Authorization: Bearer sk_test_…" \
  -H "Idempotency-Key: catalogue-prix-01" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "À l’unité",
    "amount": 10000,
    "currency": "XOF",
    "period": "one_time"
  }'

La réponse

json
{
  "object": "price",
  "id": "prx_01j9xm3kq8v2tzr5wd7n",
  "product": "prd_01j9xm2hp7t4wzq6vc3k",
  "label": "À l’unité",
  "amount": 10000,
  "currency": "XOF",
  "period": "one_time",
  "unit": null,
  "note": null,
  "active": true,
  "archived_at": null,
  "created": 1789740092,
  "livemode": false
}

Ce qu’on reçoit

201 · un objet price

object« price »Le genre de l’objet rendu : il ne change jamais.
idtexteUn identifiant préfixé « prx_ », par exemple prx_01j9xm3kq8v2tzr5wd7n.
producttexteLe produit qu’il met en vente.
labeltexteCe que le client lit : « Mensuel », « À l’unité ».
amountentierLe prix : d’une fois, d’une période, ou d’une unité à l’usage.
currencytexteLe code ISO 4217, en majuscules.
period« one_time » · « month » · « quarter » · « year » · « usage »Ce que le prix paie : une fois (« one_time »), une période (« month », « quarter », « year »), ou une unité consommée (« usage »).
unittexte ou nullÀ l’usage, ce qui se compte : « heure », « Go », « appel ». Null sinon.
notetexte ou nullUne précision, pour vous ou pour le client.
activevrai ou fauxFaux : retiré de la vente, sans être retiré du produit.
archived_atentier ou nullQuand il a été retiré du produit ; ce qui a été vendu à ce prix le désigne toujours.
createdentier ou nullDes secondes depuis 1970, ou null.
livemodevrai ou fauxFaux en mode test : aucun argent ne circule.
© 2026 PayizUne question ? L’aide est dans le rond, en bas à droite.
POST/v1/products/{id}/prices

Un prix par période proposée et par monnaie.

La période suit le type du produit. Un produit « open » n’a pas de prix : c’est le payeur qui décide.

Les en-têtes

Idempotency-KeytexteConseillée : rejouée, la même clé rend la première réponse au lieu de refaire le geste.

Ce qu’on envoie

Un corps JSON. Ce qui n’est pas requis peut être omis.

labelREQUIStexteCe que le client lit : « Mensuel », « À l’unité ».
amountREQUISentierLe prix.
currencytexteSans précision : la monnaie de l’espace.
periodREQUIS« one_time » · « month » · « quarter » · « year » · « usage »Celle que le type du produit accepte : « one_time » pour « one_time », « month », « quarter » ou « year » pour « subscription », « usage » pour « usage ».
unittexteRequis à l’usage : ce qui se compte, « heure », « Go », « appel ».
notetexteUne précision, pour vous ou pour le client.
activevrai ou fauxEn vente d’office.

La demande

bash
curl https://api.payiz.app/v1/products/prd_01j9xm2hp7t4wzq6vc3k/prices \
  -H "Authorization: Bearer sk_test_…" \
  -H "Idempotency-Key: catalogue-prix-01" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "À l’unité",
    "amount": 10000,
    "currency": "XOF",
    "period": "one_time"
  }'

La réponse

json
{
  "object": "price",
  "id": "prx_01j9xm3kq8v2tzr5wd7n",
  "product": "prd_01j9xm2hp7t4wzq6vc3k",
  "label": "À l’unité",
  "amount": 10000,
  "currency": "XOF",
  "period": "one_time",
  "unit": null,
  "note": null,
  "active": true,
  "archived_at": null,
  "created": 1789740092,
  "livemode": false
}

Ce qu’on reçoit

201 · un objet price

object« price »Le genre de l’objet rendu : il ne change jamais.
idtexteUn identifiant préfixé « prx_ », par exemple prx_01j9xm3kq8v2tzr5wd7n.
producttexteLe produit qu’il met en vente.
labeltexteCe que le client lit : « Mensuel », « À l’unité ».
amountentierLe prix : d’une fois, d’une période, ou d’une unité à l’usage.
currencytexteLe code ISO 4217, en majuscules.
period« one_time » · « month » · « quarter » · « year » · « usage »Ce que le prix paie : une fois (« one_time »), une période (« month », « quarter », « year »), ou une unité consommée (« usage »).
unittexte ou nullÀ l’usage, ce qui se compte : « heure », « Go », « appel ». Null sinon.
notetexte ou nullUne précision, pour vous ou pour le client.
activevrai ou fauxFaux : retiré de la vente, sans être retiré du produit.
archived_atentier ou nullQuand il a été retiré du produit ; ce qui a été vendu à ce prix le désigne toujours.
createdentier ou nullDes secondes depuis 1970, ou null.
livemodevrai ou fauxFaux en mode test : aucun argent ne circule.