Skip to main content
DELETE
/
v1
/
bonuses
/
{bonusId}
Node.js
import { PriceOS } from "priceos";
import type { MyFeatures } from "./priceos.types";

const priceos = new PriceOS<MyFeatures>(process.env.PRICEOS_API_KEY!);

const result = await priceos.bonuses.delete("bonus_123");
{
  "deleted": true,
  "bonusId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "counterRemaining": 123
}

Headers

x-api-key
string
required

API key from your PriceOS dashboard.

Path Parameters

bonusId
string<uuid>
required

Bonus ID.

Response

Bonus deleted

Bonus delete result.

deleted
enum<boolean>
required

Whether the bonus was deleted.

Available options:
true
bonusId
string<uuid>
required

Deleted bonus ID.

counterRemaining
number
required

Total remaining bonus amount for this customer + feature.