Documentation/Retirer un prix
openapi.jsonOuvrir mon espace

Retirer un prix

POST/v1/products/{id}/prices/{price_id}/archive

Il ne se propose plus ; ce qui a été vendu à ce prix le désigne toujours.

Il quitte les prix du produit, et ne revient pas : ajoutez-en un autre au besoin.

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.

La demande

bash
curl https://api.payiz.app/v1/products/prd_01j9xm2hp7t4wzq6vc3k/prices/prx_01j9xm3kq8v2tzr5wd7n/archive \
  -H "Authorization: Bearer sk_test_…" \
  -X POST

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

200 · 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/{price_id}/archive

Il ne se propose plus ; ce qui a été vendu à ce prix le désigne toujours.

Il quitte les prix du produit, et ne revient pas : ajoutez-en un autre au besoin.

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.

La demande

bash
curl https://api.payiz.app/v1/products/prd_01j9xm2hp7t4wzq6vc3k/prices/prx_01j9xm3kq8v2tzr5wd7n/archive \
  -H "Authorization: Bearer sk_test_…" \
  -X POST

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

200 · 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.