Headers

• X-Tenant string Required

  The domain used to access the portal.

• Authorization string Required

  JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

  Default value is Bearer eyJ0eXAiO....

• X-Correlation-Id string(UUID)

  This header is optional and by setting it you can correlate the audit logs made by this request.

Path parameters

• customerId string(uuid) Required

  GUID Unique identifier for the customer. The subscription must belong to this customer, otherwise this request will fail.

• subscriptionId string(uuid) Required

  GUID Unique identifier for the subscription.

Responses

• 200

  text/plain

  text/plain application/json text/json

  OK

  Hide response attributes Show response attributes object

  • isCompleted boolean

    The value indicating whether this subscription migration is completed or not.

  • subscriptionId string(uuid)

    The Id of the current subscription.

  • destinationSubscriptionId string(uuid) | null

    The Id of the destination subscription. Only populated when migration is completed.

  • destinationProviderSubscriptionId string | null

    The provider Id of the destination subscription. Only populated when migration is completed.

  Hide response attributes Show response attributes object

  • isCompleted boolean

    The value indicating whether this subscription migration is completed or not.

  • subscriptionId string(uuid)

    The Id of the current subscription.

  • destinationSubscriptionId string(uuid) | null

    The Id of the destination subscription. Only populated when migration is completed.

  • destinationProviderSubscriptionId string | null

    The provider Id of the destination subscription. Only populated when migration is completed.

  Hide response attributes Show response attributes object

  • isCompleted boolean

    The value indicating whether this subscription migration is completed or not.

  • subscriptionId string(uuid)

    The Id of the current subscription.

  • destinationSubscriptionId string(uuid) | null

    The Id of the destination subscription. Only populated when migration is completed.

  • destinationProviderSubscriptionId string | null

    The provider Id of the destination subscription. Only populated when migration is completed.

• 400

  text/plain

  text/plain application/json text/json

  Bad Request

  Hide response attributes Show response attributes object

  • statusCode integer(int32)

    The HTTP status code that represents a specific error scenario.

  • type string | null

    The type of error that occurred.

  • description string | null

    Describes the error scenario that occurred.

  • correlationId string | null

    The correlationId of the request that originated the error.

  • errors array[object] | null

    A list containing the detail of the errors that occurred in this error scenario.

    This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

    Hide errors attributes Show errors attributes object

    • propertyName string | null

      The name of the property involved in the error.

    • description array[string] | null

      A description of each error associated with the given property.

  Hide response attributes Show response attributes object

  • statusCode integer(int32)

    The HTTP status code that represents a specific error scenario.

  • type string | null

    The type of error that occurred.

  • description string | null

    Describes the error scenario that occurred.

  • correlationId string | null

    The correlationId of the request that originated the error.

  • errors array[object] | null

    A list containing the detail of the errors that occurred in this error scenario.

    This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

    Hide errors attributes Show errors attributes object

    • propertyName string | null

      The name of the property involved in the error.

    • description array[string] | null

      A description of each error associated with the given property.

  Hide response attributes Show response attributes object

  • statusCode integer(int32)

    The HTTP status code that represents a specific error scenario.

  • type string | null

    The type of error that occurred.

  • description string | null

    Describes the error scenario that occurred.

  • correlationId string | null

    The correlationId of the request that originated the error.

  • errors array[object] | null

    A list containing the detail of the errors that occurred in this error scenario.

    This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

    Hide errors attributes Show errors attributes object

    • propertyName string | null

      The name of the property involved in the error.

    • description array[string] | null

      A description of each error associated with the given property.

• 401

  Unauthorized

• 403

  Forbidden

• 404

  text/plain

  text/plain application/json text/json

  Not Found

  Hide response attributes Show response attributes object

  • statusCode integer(int32)

    The HTTP status code that represents a specific error scenario.

  • type string | null

    The type of error that occurred.

  • description string | null

    Describes the error scenario that occurred.

  • correlationId string | null

    The correlationId of the request that originated the error.

  • errors array[object] | null

    A list containing the detail of the errors that occurred in this error scenario.

    This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

    Hide errors attributes Show errors attributes object

    • propertyName string | null

      The name of the property involved in the error.

    • description array[string] | null

      A description of each error associated with the given property.

  Hide response attributes Show response attributes object

  • statusCode integer(int32)

    The HTTP status code that represents a specific error scenario.

  • type string | null

    The type of error that occurred.

  • description string | null

    Describes the error scenario that occurred.

  • correlationId string | null

    The correlationId of the request that originated the error.

  • errors array[object] | null

    A list containing the detail of the errors that occurred in this error scenario.

    This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

    Hide errors attributes Show errors attributes object

    • propertyName string | null

      The name of the property involved in the error.

    • description array[string] | null

      A description of each error associated with the given property.

  Hide response attributes Show response attributes object

  • statusCode integer(int32)

    The HTTP status code that represents a specific error scenario.

  • type string | null

    The type of error that occurred.

  • description string | null

    Describes the error scenario that occurred.

  • correlationId string | null

    The correlationId of the request that originated the error.

  • errors array[object] | null

    A list containing the detail of the errors that occurred in this error scenario.

    This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

    Hide errors attributes Show errors attributes object

    • propertyName string | null

      The name of the property involved in the error.

    • description array[string] | null

      A description of each error associated with the given property.

• 500

  text/plain

  text/plain application/json text/json

  Internal Server Error

  Hide response attributes Show response attributes object

  • statusCode integer(int32)

    The HTTP status code that represents a specific error scenario.

  • type string | null

    The type of error that occurred.

  • description string | null

    Describes the error scenario that occurred.

  • correlationId string | null

    The correlationId of the request that originated the error.

  • errors array[object] | null

    A list containing the detail of the errors that occurred in this error scenario.

    This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

    Hide errors attributes Show errors attributes object

    • propertyName string | null

      The name of the property involved in the error.

    • description array[string] | null

      A description of each error associated with the given property.

  Hide response attributes Show response attributes object

  • statusCode integer(int32)

    The HTTP status code that represents a specific error scenario.

  • type string | null

    The type of error that occurred.

  • description string | null

    Describes the error scenario that occurred.

  • correlationId string | null

    The correlationId of the request that originated the error.

  • errors array[object] | null

    A list containing the detail of the errors that occurred in this error scenario.

    This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

    Hide errors attributes Show errors attributes object

    • propertyName string | null

      The name of the property involved in the error.

    • description array[string] | null

      A description of each error associated with the given property.

  Hide response attributes Show response attributes object

  • statusCode integer(int32)

    The HTTP status code that represents a specific error scenario.

  • type string | null

    The type of error that occurred.

  • description string | null

    Describes the error scenario that occurred.

  • correlationId string | null

    The correlationId of the request that originated the error.

  • errors array[object] | null

    A list containing the detail of the errors that occurred in this error scenario.

    This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

    Hide errors attributes Show errors attributes object

    • propertyName string | null

      The name of the property involved in the error.

    • description array[string] | null

      A description of each error associated with the given property.