XML element GetPricingPlansResponse

Reference for RimuHosting's Data Structures (as used in our REST-ful APIs)

These data structures are used in our REST-ful APIs.
These data structures and their fields are in beta and subject to change. If you need to rely on them being stable, please contact RimuHosting so we can advise.

Name: GetPricingPlansResponse

The response to the pricing plans listing resource.

XML Example:

<GetPricingPlansResponse>
  <error_info>IErrorInfo</error_info>
  zero or N[<extended_error_infos>IErrorInfo</extended_error_infos>]
  <human_readable_message>xsd:string</human_readable_message>
  <plan_filter>PlanFilter</plan_filter>
  zero or N[<pricing_plan_infos>PricingPlanInfo</pricing_plan_infos>]
  <redirect_uri>xsd:string</redirect_uri>
  <response_display_duration_type>SHORT | REGULAR | PERMANENT</response_display_duration_type>
  <response_type>OK | ERROR</response_type>
  <status_code>xsd:int</status_code>
  <status_message>xsd:string</status_message>
</GetPricingPlansResponse>

JSON Example:

{"GetPricingPlansResponse":
 {
   "error_info": IErrorInfo,
   "extended_error_infos": [IErrorInfo],
   "human_readable_message": String,
   "plan_filter": PlanFilter,
   "pricing_plan_infos": [PricingPlanInfo],
   "redirect_uri": String,
   "response_display_duration_type": 'SHORT' | 'REGULAR' | 'PERMANENT',
   "response_type": 'OK' | 'ERROR',
   "status_code": Number,
   "status_message": String,
 }
}

Elements
Name	Type	Required	Nillable	Description
error_info	IErrorInfo	false	false	If the response type is an error, then this can contain more information about the error.
extended_error_infos	zero or N[IErrorInfo]	false	false	e.g.
human_readable_message	xsd:string	false	false	A message summarizing the request result.
plan_filter	PlanFilter	false	false	The plan filter, if any, we used to select the resulting pricing plans.
pricing_plan_infos	zero or N[PricingPlanInfo]	false	false	The pricing plans that match the filter you provided (no filter, then all current plans are returned).
redirect_uri	xsd:string	false	false	A suggestion from the server about which URI to go to after this request.
response_display_duration_type	SHORT \| REGULAR \| PERMANENT	false	false	An indicator for a UI about how long to display a message.
response_type	OK \| ERROR	false	false	Whether the response is an AOK or error response.
status_code	xsd:int	false	false	May the status code be for ever 2xx.
status_message	xsd:string	false	false	The status message (should match the status code).