Plans

Update plan

Changed on

Use when changing plan details (e.g. name, interval, or metadata). Partial update supported.

put/plans/{id}

Request

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

Path parameters

idstring required

Plan ID

Request body

descriptionstring
display_orderinteger
lookup_keystring
metadataTypesMetadata
namestring

Response

OK

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