v1

latestOpenAPI 3.0.3Apache 2.02026-07-13121230447.8 KB
Price Plans

Update a price plan

Update an existing price plan Price Plans with status as DRAFT alone can be updated . Learn more about Price plans from our Guides

patch/price_plans/{price_plan_id}

Path parameters

price_plan_idstring required
Example:pp.1zYnCiM9Bpg.lv25y

Request body

descriptionstring

Description of price plan

migrationMode'IMMEDIATE' | 'IMMEDIATE_IGNORE_OVERRIDE' | 'NEXT_CYCLE' | 'NEXT_CYCLE_IGNORE_OVERRIDE' | 'NONE'
versionsToMigrate'LATEST_VERSION' | 'ALL_VERSION'

Response

Response for Create and Get price plan requests

idstring required

Price plan id

namestring required

Name of the price plan

type'BILLING' | 'PURCHASE' required

Type of price plan

descriptionstring

Description of price plan

status'DRAFT' | 'ACTIVE' | 'ARCHIVED' required

Status of Price plan