Catalogue

What the organization sells: products and their groups, plans, prices and standalone service items.

Families on this page

Family	Tools	read	write	destructive
products — Products and product groups	24	4	17	3
plans — Plans, prices and groups	20	5	12	3
services — Service items	6	2	3	1

products

Tool	Kind	Permission	Endpoint	What it does
billing_products_list	read	products.list	GET /v1/products	List products in the catalog.
billing_products_get	read	products.show	GET /v1/products/:id	Fetch one product with its prices.
billing_products_create	write	products.create	POST /v1/products	Create a product, optionally with its prices in the same call.
billing_products_upsert	write	products.create	PUT /v1/products	Create or update a product matched on id → external_id → slug.
billing_products_update	write	products.update	PATCH /v1/products/:id	Update a product in place.
billing_products_delete	destructive	products.delete	DELETE /v1/products/:id	Soft-delete a product.
billing_products_publish	write	products.update	POST /v1/products/:id/publish	Move a draft product to active, making it sellable.
billing_products_archive	write	products.update	POST /v1/products/:id/archive	Archive a product: it stops being sellable but existing subscriptions keep billing it.
billing_products_restore	write	products.update	POST /v1/products/:id/restore	Bring an archived product back to active.
billing_products_reorder	write	products.update	POST /v1/products/reorder	Set the catalog display order.
billing_products_bulk_archive	write	products.update	POST /v1/products/bulk-archive	Archive up to 100 products in one call.
billing_products_bulk_delete	destructive	products.delete	POST /v1/products/bulk-delete	Soft-delete up to 100 products in one call.
billing_products_bulk_move_group	write	products.update	POST /v1/products/bulk-move-group	Move products to a product group.
billing_products_bulk_change_company	write	products.update	POST /v1/products/bulk-change-company	Reassign the issuing legal entity of several products.
billing_products_bulk_visibility	write	products.update	POST /v1/products/bulk-visibility	Set several products public or private at once.
billing_product_groups_list	read	products.list	GET /v1/product_groups	List product groups — the catalog sections products are filed under.
billing_product_groups_get	read	products.show	GET /v1/product_groups/:id	Fetch one product group with its display order.
billing_product_groups_create	write	products.create	POST /v1/product_groups	Create a product group to file products under.
billing_product_groups_upsert	write	products.create	PUT /v1/product_groups	Create or update a product group matched on id → external_id → slug.
billing_product_groups_update	write	products.update	PATCH /v1/product_groups/:id	Update a product group — name, slug, company or display order.
billing_product_groups_delete	destructive	products.delete	DELETE /v1/product_groups/:id	Soft-delete a product group.
billing_product_groups_archive	write	products.update	POST /v1/product_groups/:id/archive	Archive a product group, hiding it from the catalog.
billing_product_groups_unarchive	write	products.update	DELETE /v1/product_groups/:id/archive	Bring an archived product group back into the catalog.
billing_product_groups_reorder	write	products.update	POST /v1/product_groups/reorder	Set the display order of product groups.

plans

Tool	Kind	Permission	Endpoint	What it does
billing_plans_list	read	plans.list	GET /v1/plans	List plans — the bundles of products a subscription can point at.
billing_plans_get	read	plans.show	GET /v1/plans/:id	Fetch one plan with its items.
billing_plans_create	write	plans.create	POST /v1/plans	Create a plan, optionally with its items in the same call.
billing_plans_upsert	write	plans.create	PUT /v1/plans	Create or update a plan matched on id → external_id → slug.
billing_plans_update	write	plans.update	PATCH /v1/plans/:id	Update a plan in place.
billing_plans_delete	destructive	plans.delete	DELETE /v1/plans/:id	Soft-delete a plan.
billing_plans_duplicate	write	plans.create	POST /v1/plans/:id/duplicate	Copy a plan and its items into a new draft plan.
billing_plans_items_list	read	plans.show	GET /v1/plans/:id/items	List the items of a plan — which product, at which price, in which quantity.
billing_plans_items_replace	write	plans.update	PUT /v1/plans/:id/items	Replace every item of a plan atomically.
billing_plans_bulk_archive	write	plans.update	POST /v1/plans/bulk-archive	Archive up to 100 plans in one call.
billing_plans_bulk_delete	destructive	plans.delete	POST /v1/plans/bulk-delete	Soft-delete up to 100 plans in one call.
billing_plans_bulk_move_group	write	plans.update	POST /v1/plans/bulk-move-group	Move plans to a plan group.
billing_plan_groups_list	read	plans.list	GET /v1/plan_groups	List plan groups — the sections plans are filed under in the catalog.
billing_plan_groups_get	read	plans.show	GET /v1/plan_groups/:id	Fetch one plan group with its display order.
billing_plan_groups_create	write	plans.create	POST /v1/plan_groups	Create a plan group to file plans under.
billing_plan_groups_upsert	write	plans.create	PUT /v1/plan_groups	Create or update a plan group matched on id → external_id → slug.
billing_plan_groups_update	write	plans.update	PATCH /v1/plan_groups/:id	Update a plan group — name, slug, description or display order.
billing_plan_groups_delete	destructive	plans.delete	DELETE /v1/plan_groups/:id	Soft-delete a plan group.
billing_plan_groups_archive	write	plans.update	POST /v1/plan_groups/:id/archive	Archive a plan group, hiding it from the catalog without touching its plans.
billing_plan_groups_reorder	write	plans.update	POST /v1/plan_groups/reorder	Set the display order of plan groups.

services

Tool	Kind	Permission	Endpoint	What it does
billing_service_items_list	read	services.list	GET /v1/service_items	List fiscal service items — the LC 116 / NBS classification an invoice line is issued under.
billing_service_items_get	read	services.show	GET /v1/service_items/:id	Fetch one service item with its fiscal codes and default ISS rate.
billing_service_items_create	write	services.create	POST /v1/service_items	Create a fiscal service item for products to be invoiced under.
billing_service_items_upsert	write	services.create	PUT /v1/service_items	Create or update a service item matched on id → external_id → internal_code.
billing_service_items_update	write	services.update	PATCH /v1/service_items/:id	Update a service item.
billing_service_items_delete	destructive	services.delete	DELETE /v1/service_items/:id	Soft-delete a service item.

---

The fields of each resource are in the API reference and in billing_schemas_get.

A tool you cannot run is not listed by tools/list at all. If one from this page is missing, see Authentication.