STstiggio
Plans

Update a plan

Changed on

Updates an existing plan's properties such as display name, description, and metadata.

patch/api/v1/plans/{id}

Request

  • Base URL
    https://api.stigg.io
  • URL
    https://api.stigg.io/api/v1/plans/{id}
  • Auth
    API key in header X-API-KEY

Path parameters

idstring required

The unique identifier of the entity

Headers

X-ACCOUNT-IDstring

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-IDstring

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Request body

displayNamestring

The display name of the package

descriptionstring nullable

The description of the package

billingIdstring nullable

The unique identifier for the entity in the billing provider

metadataobject

Metadata associated with the entity

parentPlanIdstring nullable

The ID of the parent plan, if applicable

compatibleAddonIdsstring[] nullable

Response

The updated plan object.

Changes

  • 3e2c8cfcd035Revision changes
    • warning

      removed the request property ///

    • warning

      removed the request property ///

  • 913f273cc2f7Revision changes
    • warning

      added the new ContractNotFound enum value to the response property for the response status