Plans

Clone a plan

Changed on

Clone an existing plan, copying its active prices, published entitlements, and published credit grants

post/plans/{id}/clone

Request

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

Path parameters

idstring required

Source Plan ID

Request body

descriptionstring

Description overrides the source plan's description when provided

display_orderinteger

DisplayOrder overrides the source plan's display order when provided

lookup_keystring

LookupKey is required and must be unique across published plans

metadataTypesMetadata
namestring

Name is required and must be different from the source plan's name

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