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}

Request

Base URL
https://api.togai.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/togaihq/apis/togai-apis/docs/price_plans/:price_plan_id/patch.ts
A function with typed inputs. Its response is checked against the schema.

price_plan_idstring required

Example:pp.1zYnCiM9Bpg.lv25y

descriptionstring

Description of price plan

migrationMode'IMMEDIATE' | 'IMMEDIATE_IGNORE_OVERRIDE' | 'NEXT_CYCLE' | 'NEXT_CYCLE_IGNORE_OVERRIDE' | 'NONE'

versionsToMigrate'LATEST_VERSION' | 'ALL_VERSION'

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

Jul 11, 202465e7e87bb244 Revision changes
- info
  added the new optional request property //
- info
  added the optional property //// to the response with the status
May 27, 20242b8be460ec6a Revision changes
- info
  added the new optional request property ///
- info
  added the optional property ///// to the response with the status