Create a price plan migration
Migrates accounts across price plans. This is an asynchronous process functioning on top of Togai’s Jobs framework. Status of the created migrations can be obtained using the Jobs APIs
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Request to create price plan migration request
Id of source price plan
255Version of the source price plan
IMMEDIATE, IMMEDIATE_IGNORE_OVERRIDE, NEXT_CYCLE, NEXT_CYCLE_IGNORE_OVERRIDE, START_OF_CURRENT_CYCLE Id of target price plan
255Version of the target price plan
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 BadRequestas no existing price plan configuration found on date of association
This field specifies whether to process job or to wait till the job is confirmed. Default value: false