Skip to navigation
API Referencewordpress

Preview the cost of changing plan

Returns the prorated charge for moving to a different package, without changing anything. The charge covers the remainder of the current billing period and reflects any account discount.

Authentication

X-API-Client-IDstring
API Client ID
X-API-Client-Secretstring
API Client Secret

Request

This endpoint expects an object.
packageLabelstringRequired
New package label to upgrade to

Response

Prorated cost of the plan change
proratedChargedouble
Amount charged now for the rest of the current billing period.
monthlyDifferencedouble
Difference between the new and current monthly rates, before any discount.
periodStartdatetime
Start of the period the prorated charge covers.
periodEnddatetime
End of the period the prorated charge covers.
discountdoubleOptional
Amount taken off by an account discount. Omitted when no discount applies.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error