Skip to main content
POST
/
v2
/
price_plans
/
{price_plan_id}
/
finalize
Finalize a price plan
curl --request POST \
  --url https://api.togai.com/v2/price_plans/{price_plan_id}/finalize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "migrationMode": "IMMEDIATE",
  "versionsToMigrate": "LATEST_VERSION"
}
'
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
price_plan_id
string
required
Maximum string length: 50
Example:

"pp.1zYnCiM9Bpg.lv25y"

Body

application/json

Payload to finalize price plan

Request to finalize a price plan version

​
migrationMode
enum<string>
Available options:
IMMEDIATE,
IMMEDIATE_IGNORE_OVERRIDE,
NEXT_CYCLE,
NEXT_CYCLE_IGNORE_OVERRIDE,
NONE,
START_OF_CURRENT_CYCLE
​
versionsToMigrate
enum<string>
Available options:
LATEST_VERSION,
ALL_VERSION

Response

OK

​
success
boolean
required
Example:

true