redocly logoAPI docs by Redocly

F5 Distributed Cloud Services API for ves.io.schema.billing.plan_transition

Download OpenAPI specification:Download

Package plan transition is responsible for storing and managing requests to move from one billing plan to another.

GetPlanTransition

API to get plan transition details by a plan transition request uid returned from InitiatePlanTransition. For now this one returns only current State

Examples of this operation
query Parameters
id
string

x-example: "dec2417d-adb1-4fcc-8dcd-529b1d31a652" Id of the plan transition request

Responses

Response samples

Content type
application/json
{
  • "state": "STATE_UNSPECIFIED"
}

InitiatePlanTransition

API to create a plan transition request in db.

Examples of this operation
path Parameters
namespace
required
string

Namespace

x-example: "system" This namespace is not used, all requests are stored under system namespace.

Request Body schema: application/json
required
namespace
string (Namespace)

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

Example: "system"

new_plan
string (New plan)

New plan template name tenant want to move to

Example: "plan-1"

object (TransitionPayload)

Payload which is required to execute transition from the current tenant's plan to a given new_plan

Responses

Request samples

Content type
application/json
{
  • "namespace": "string",
  • "new_plan": "string",
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "requires_manual_approval": true
}