Products

What you sell. A product groups one or more prices.

The product object

idstring
Prefixed prod_.
namestring
descriptionstring | null
activeboolean
Inactive products cannot get new subscriptions.
metadataobject
created_attimestamp
updated_attimestamp

Create a product

POST/v1/productsSecret key

Body

namestringrequired
descriptionstring
metadataobject
Node.jsts
const product = await borga.products.create({
  name: "Pro plan",
  description: "Everything in Starter plus priority support",
});

const monthly = await borga.prices.create({
  product: product.id,
  type: "recurring",
  currency: "ISK",
  unit_amount: 4990, // 4.990 kr. per seat per month
  recurring: { interval: "month", interval_count: 1 },
});

const yearly = await borga.prices.create({
  product: product.id,
  type: "recurring",
  currency: "ISK",
  unit_amount: 49900,
  recurring: { interval: "year" },
});

Retrieve a product

GET/v1/products/:idSecret key

Update a product

PATCH/v1/products/:idSecret key

Body

namestring
descriptionstring
activeboolean
metadataobject

List products

GET/v1/productsSecret key

Query parameters

limitintegerdefault: 25
starting_afterstring