Reference / Monetization

Update a customer plan.

PATCH /v1/billing/customer-plans/{id}

Secret API key operationId: update_plan

Authorization

Server-to-server. Send a secret key as a Bearer token plus the x-application-id header.

Path parameters

id string<uuid> required

Plan id

Request body · required

active boolean
description string
interval string
is_public boolean
name string
per_seat_cents integer<int64> int64
price_cents integer<int64> int64

Responses

200 Plan updated

{
  "data": {
    "active": false,
    "created_at": "2026-01-15T09:30:00Z",
    "currency": "string",
    "description": "string",
    "id": "018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f",
    "interval": "string",
    "is_public": false,
    "key": "pro_team",
    "name": "string",
    "per_seat_cents": 0,
    "price_cents": 0
  },
  "error": {
    "code": "string",
    "message": "string"
  },
  "meta": {
    "timestamp": "string"
  },
  "success": false
}

404 No such plan

422 Invalid input

Request

curl -X PATCH "http://localhost:8080/v1/billing/customer-plans/018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f" \
  -H "Content-Type: application/json" \
  -d '{
  "active": false,
  "description": "string",
  "interval": "string",
  "is_public": false,
  "name": "string",
  "per_seat_cents": 0,
  "price_cents": 0
}'

Try it

live request

PATCH http://localhost:8080/v1/billing/customer-plans/018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f

Path parameters

id *

Request body

application/json