Plan groups

The shelf plans are displayed and ordered on. reorder changes the order; archive takes the group out of circulation without deleting it.

Command	HTTP	Description
plan-groups list	GET /v1/plan_groups	List plan groups
plan-groups create	POST /v1/plan_groups	Create a plan group
plan-groups get	GET /v1/plan_groups/{id}	Get a plan group
plan-groups update	PATCH /v1/plan_groups/{id}	Update a plan group
plan-groups delete	DELETE /v1/plan_groups/{id}	Remove a plan group
plan-groups archive	POST /v1/plan_groups/{id}/archive	Archive a plan group
plan-groups reorder create	POST /v1/plan_groups/reorder	Reorder plan groups

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 plan groups
kobana billing plan-groups list \
  --fields "id,public_id,external_id,organization_id,company_id"

# Get a plan group
kobana billing plan-groups get --params '{"id": "PLAN_GROUP_ID"}'

# Create a plan group
kobana billing plan-groups create --json '{"name": "NAME"}'

# Update a plan group
kobana billing plan-groups update \
  --params '{"id": "PLAN_GROUP_ID"}' \
  --json '{"name": "NAME", "slug": "SLUG", "external_id": "EXTERNAL_ID"}'

# Archive a plan group
kobana billing plan-groups archive --params '{"id": "PLAN_GROUP_ID"}'

# Remove a plan group
kobana billing plan-groups delete --params '{"id": "PLAN_GROUP_ID"}' --dry-run

Next steps

• Products
• Schema introspection — every parameter this resource accepts.