Plans

Create plan

Changed on

Use when defining a new pricing plan (e.g. Free, Pro, Enterprise). Attach prices and entitlements; customers subscribe to plans.

post/plans

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/plans
  • Auth
    API key in header x-api-key

Request body

descriptionstring
display_orderinteger
lookup_keystring
metadataTypesMetadata
namestring required

Response

Created

created_atstring date-time
created_bystring
descriptionstring
display_orderinteger
environment_idstring
idstring
lookup_keystring
metadataTypesMetadata
namestring
status'published' | 'deleted' | 'archived'
tenant_idstring
updated_atstring date-time
updated_bystring

Changes