Products

The catalogue of what you charge for, item by item, before it becomes a plan or an invoice line. Publish, archive and restore control visibility without destroying history.

Command	HTTP	Description
products list	GET /v1/products	List products
products create	POST /v1/products	Create a product
products get	GET /v1/products/{id}	Get a product
products update	PATCH /v1/products/{id}	Update a product
products delete	DELETE /v1/products/{id}	Archive a product (soft delete)
products archive	POST /v1/products/{id}/archive	Archive a product
products publish	POST /v1/products/{id}/publish	Publish a product
products restore	POST /v1/products/{id}/restore	Restore an archived product
products bulk-archive create	POST /v1/products/bulk-archive	Archive products in bulk
products bulk-change-company create	POST /v1/products/bulk-change-company	Change products' company in bulk
products bulk-delete create	POST /v1/products/bulk-delete	Delete products in bulk
products bulk-move-group create	POST /v1/products/bulk-move-group	Move products to another group
products bulk-visibility create	POST /v1/products/bulk-visibility	Change visibility in bulk
products reorder create	POST /v1/products/reorder	Reorder products
products reorder update	PUT /v1/products/reorder	Reorder products (PUT /reorder)

Examples

--params carries query and path parameters (id, page, filters); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference.

# List products
kobana billing products list \
  --fields "id,public_id,external_id,organization_id,company_id"

# Get a product
kobana billing products get --params '{"id": "PRODUCT_ID"}'

# Create a product
kobana billing products create --json '{"name": "NAME", "slug": "SLUG"}'

# Update a product
kobana billing products update \
  --params '{"id": "PRODUCT_ID"}' \
  --json '{"name": "NAME", "slug": "SLUG", "description": "DESCRIPTION"}'

# Archive a product
kobana billing products archive --params '{"id": "PRODUCT_ID"}'

# Archive a product (soft delete)
kobana billing products delete --params '{"id": "PRODUCT_ID"}' --dry-run

Next steps

• Product groups
• Schema introspection — every parameter this resource accepts.