STstiggio
Plans

Create plan

Changed on

Creates a new plan in draft status.

post/api/v1/plans

Request

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

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

idstring required

The unique identifier for the entity

displayNamestring required

The display name of the package

descriptionstring nullable

The description of the package

productIdstring required

The product ID to associate the plan with

parentPlanIdstring nullable

The ID of the parent plan, if applicable

pricingType'FREE' | 'PAID' | 'CUSTOM' nullable

The pricing type of the package

billingIdstring nullable

The unique identifier for the entity in the billing provider

status'DRAFT' | 'PUBLISHED' | 'ARCHIVED'

The status of the package

metadataobject

Metadata associated with the entity

Response

The newly created plan object.

Changes

  • b876edd1a4fcRevision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

      removed the InvoicePreviewNotAvailableForDraftContract enum value from the response property for the response status

  • 58bb216ff8ceRevision changes
    • warning

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