Skip to main content
SaaS Billing2026.8.0

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.

POST/api/v1/billing/saas/{productKey}/plan-change/preview

The 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 authentication

Path parameters

productKeystringRequired

No parameter description supplied.

Query parameters

None declared in this export.

Header parameters

None declared in this export.

Request body

application/json · Required

spaceIdstring (uuid)Required

No field description supplied.

planIdstringRequired

No field description supplied.

Responses

200

Signed plan review.

tokenstringOptional

No field description supplied.

planobjectOptional

No field description supplied.

directionstringOptional

Allowed values: "upgrade", "downgrade".

effectiveAtstring (date-time)Optional

No field description supplied.

expiresAtstring (date-time)Optional

No field description supplied.

amountDueintegerOptional

No field description supplied.

currencystringOptional

No 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?