Skip to main content
POST
/
v2
/
price_plans
/
migration
Create a price plan v2 migration
curl --request POST \
  --url https://api.togai.com/v2/price_plans/migration \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "requireConfirmation": true,
  "sourceId": "pp.1zYnCiM9Bpg.lv25y",
  "sourceVersion": 1,
  "targetId": "pp.2zYnCiM9Bpg.bfeu2",
  "targetVersion": 2,
  "migrationMode": "IMMEDIATE"
}'
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Payload to create price plan migration request

Request to create price plan migration request

​
sourceId
string
required

Id of source price plan

Maximum string length: 255
​
sourceVersion
integer<int32>
required

Version of the source price plan

​
migrationMode
enum<string>
required
Available options:
IMMEDIATE,
IMMEDIATE_IGNORE_OVERRIDE,
NEXT_CYCLE,
NEXT_CYCLE_IGNORE_OVERRIDE,
START_OF_CURRENT_CYCLE
​
targetId
string

Id of target price plan

Maximum string length: 255
​
targetVersion
integer<int32>

Version of the target price plan

​
retainStartOffsets
boolean

If this flag is true, current pricing cycle of the account on the date of association will continue rather than the configurations of the newly associated price plan. Pricing cycle overrides specified using pricePlanDetailsOverride will take precedence over the pricing cycle configurations of the new price plan that the account needs to migrate to. PricingCycleInterval of the existing plan and the new plan must be same for this to work. We'll return a 400 BadRequest otherwise. Examples:

  • Ongoing plan (1st Oct to 30th Oct) - {dayOffset: 1, monthOffset: NIL} New association (15th Oct to 15th Nov) of different price plan with retainStartOffsets option true will use the same pricing cycle configuration {dayOffset: 1, monthOffset: NIL} rather than using the pricing cycle configuration of the new price plan that the account needs to migrate to.
  • Ongoing plan (1st Oct to 30th Oct) - {dayOffset: 1, monthOffset: NIL} New association (1st Nov to 30th Nov) of different price plan with retainStartOffsets option true will throw a 400 BadRequest as no existing price plan configuration found on date of association
​
isPricePlanV2Migration
boolean

If this flag is true, the migration will be done for price plan v2. Default value is false

​
requireConfirmation
boolean

This field specifies whether to process job or to wait till the job is confirmed. Default value: false

Response

OK

​
success
boolean
required
Example:

true