Review a Signature upgrade or downgrade
Owner/admin only. Returns a signed ten-minute review, the prorated amount for immediate upgrades, or the renewal date for downgrades. Does not modify the subscription.
/api/v1/billing/saas/{productKey}/plan-change/previewThe source export uses a local development server. Examples use the configured Dashio API origin.
The export references authentication schemes without supplying their definitions.
Authentication
bearerAuth
Understand authenticationPath parameters
productKeystringRequiredNo parameter description supplied.
Query parameters
None declared in this export.
Header parameters
None declared in this export.
Request body
application/json · Required
spaceIdstring (uuid)RequiredNo field description supplied.
planIdstringRequiredNo field description supplied.
Responses
200
Signed plan review.
tokenstringOptionalNo field description supplied.
planobjectOptionalNo field description supplied.
directionstringOptionalAllowed values: "upgrade", "downgrade".
effectiveAtstring (date-time)OptionalNo field description supplied.
expiresAtstring (date-time)OptionalNo field description supplied.
amountDueintegerOptionalNo field description supplied.
currencystringOptionalNo field description supplied.
400
Invalid plan or Space.
No response body schema supplied.
401
Authentication required.
No response body schema supplied.
403
Owner/admin required.
No response body schema supplied.
404
Product disabled.
No response body schema supplied.
409
Plan cannot currently be changed.
No response body schema supplied.
415
JSON required.
No response body schema supplied.
503
Pricing unavailable.
No response body schema supplied.
Was this helpful?