InitiatePlanTransition.

POST

/api/web/namespaces/{namespace}/billing/plan_transition

curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/web/namespaces/example/billing/plan_transition \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "namespace": "example", "new_plan": "example", "payload": { "billing_address": { "address1": "example", "address2": "example", "city": "example", "contact_type": "MAILING", "country": "example", "county": "example", "phone_number": "example", "state": "example", "state_code": "example", "zip_code": "example" }, "billing_provider_account_id": "example", "create_support_ticket": true, "deletion_feedback": "example", "deletion_reason": "REASON_UNKNOWN", "domain": "example", "payment_address": { "address1": "example", "address2": "example", "city": "example", "contact_type": "MAILING", "country": "example", "county": "example", "phone_number": "example", "state": "example", "state_code": "example", "zip_code": "example" }, "payment_provider_token": "example", "subscribe_addon_services": [ "example" ], "support_ticket_info": "example", "tp_subscription_id": "example", "unsubscribe_addon_services": [ "example" ] } }'

• F5 Distributed Cloud Console

API to create a plan transition request in db.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace This namespace is not used, all requests are stored under system namespace.

Request Body^required

Media typeapplication/json

InitiatePlanTransitionReq

Request body of InitiatePlanTransition custom API.

object

namespace

Namespace

This namespace is not used, all requests are stored under system namespace.

string

>= 6 characters <= 1024 characters

new_plan

New plan

New plan template name tenant want to move to.

string

<= 1024 characters

payload

object

billing_address

object

address1

address1

Network address or location

string

<= 1024 characters

address2

address2

Network address or location

string

<= 1024 characters

city

city

Configuration parameter for city

string

<= 1024 characters

contact_type

string

default: MAILING

Allowed values: MAILING BILLING PAYMENT

country

country

Configuration parameter for country

string

<= 1024 characters

county

county

Configuration parameter for county

string

<= 1024 characters

phone_number

phone_number

Configuration parameter for phone number

string

<= 1024 characters

state

state

Current state of the resource

string

<= 1024 characters

state_code

state code

Configuration parameter for state code

string

<= 1024 characters

zip_code

zip_code

IP address configuration

string

<= 1024 characters

billing_provider_account_id

billing_provider_account_id

ID of the billing provider account created to verify the billing info provided with this object. The ID is then used to ensure no more duplicate billing account is created. Note: this is set by the backend during the creation of plan_transition object. Anything passed from UI will be ignored.

string

<= 1024 characters

create_support_ticket

create_support_ticket

If set to true, a support ticket will be created to provide the plan transition request.

boolean format: boolean

deletion_feedback

Feedback

Feedback from the customer related to reason of account deletion.

string

<= 1024 characters

deletion_reason

string

default: REASON_UNKNOWN

Allowed values: REASON_UNKNOWN REASON_SWITCH_TO_FREE_PLAN REASON_NO_LONGER_NEEDED REASON_NOT_JUSTIFY_COSTS REASON_DIFFICULT_TO_USE

domain

payment_provider_token

Domain for enterprise tenants.

string format: hostname

>= 26 characters <= 1024 characters

payment_address

object

address1

address1

Network address or location

string

<= 1024 characters

address2

address2

Network address or location

string

<= 1024 characters

city

city

Configuration parameter for city

string

<= 1024 characters

contact_type

string

default: MAILING

Allowed values: MAILING BILLING PAYMENT

country

country

Configuration parameter for country

string

<= 1024 characters

county

county

Configuration parameter for county

string

<= 1024 characters

phone_number

phone_number

Configuration parameter for phone number

string

<= 1024 characters

state

state

Current state of the resource

string

<= 1024 characters

state_code

state code

Configuration parameter for state code

string

<= 1024 characters

zip_code

zip_code

IP address configuration

string

<= 1024 characters

payment_provider_token

payment_provider_token

Payment provider token (for credit card details)

string

<= 1024 characters

subscribe_addon_services

subscribe_addon_services

List of addon services that needs to be subscribed/enabled part of this plan transition.

Array<string>

support_ticket_info

support_ticket_info

Additional information user want to record part of the support ticket.

string

<= 1024 characters

tp_subscription_id

tp_subscription_id

ID of the third party subscription ID created. Note: this is set by the backend as part of the notifiers run as the plan_transition object is created.

string

<= 1024 characters

unsubscribe_addon_services

unsubscribe_addon_services

List of addon services that needs to be unsubscribed/removed part of this plan transition.

Array<string>

Responses

200

A successful response.

Media typeapplication/json

InitiatePlanTransitionRsp

Response body of InitiatePlanTransition custom API.

object

id

id

ID of the newly created plan transition request.

string

>= 1 <= 4094 <= 1024 characters

requires_manual_approval

requires_manual_approval

Flag to specify whether the request requires manual approval.

boolean format: boolean

Example^generated

{
  "id": "example",
  "requires_manual_approval": true
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example