Skip to main content
Developer Marketing Billing1.0.0-beta.1

Read the next scheduled Marketing plan change

Reads the next Dashio-managed Signatures plan change for the token Space and indicates when a plan change needs payment. A null change means there is no next scheduled Dashio change. Open the Marketing billing panel to review or confirm payment.

GET/api/v1/marketing/subscription/scheduled-change

Workspace automation for approved Dashio products. Each token is scoped to one Space and independently granted operations. Requests spend shared minute credits, and selected operation groups also share hourly quotas.

Required token scope is marketing:subscription:read. Scopes are independent.

This operation uses 8 credits from a shared budget of 60 credits per token and 300 per Space each UTC minute. The provider group shares 40 requests per token and 100 per Space each UTC hour.

Run these examples on a trusted server with DASHIO_API_TOKEN configured. Use a private terminal when inspecting response data. Examples send one request with a bounded timeout and do not retry automatically.

Authentication

Dashio developer token (HTTP Bearer) API authentication guide

Path parameters

None documented.

Query parameters

None documented.

Header parameters

None documented.

Request body

No content type declared

No request body schema is documented.

Responses

Headers on every response

X-Request-Idstring (uuid)Optional

Server-generated ID to include in a support request.

200

The current scheduled change and pending payment indicator.

Response headers

RateLimit-LimitintegerOptional

Per-token capacity in the reported gateway window, expressed in requests of this operation. A shared Space budget also applies. Present when the request reaches the authenticated gateway. Minimum: 1.

RateLimit-RemainingintegerOptional

Requests of this operation remaining under the current token, Space and applicable operation-group quotas. Present when the request reaches the authenticated gateway. Minimum: 0.

RateLimit-ResetintegerOptional

Unix timestamp in seconds when the reported gateway quota resets. Present when the request reaches the authenticated gateway. Minimum: 0.

application/json

scheduledChangeobject | nullRequired

No field description supplied.

paymentPendingbooleanRequired

Whether the billing panel has a recoverable plan-change payment.

400

Unsupported query parameters.

application/json

statusCodeintegerRequired

Minimum: 400. Maximum: 599.

statusMessagestringOptional

A safe explanation suitable for display.

dataobjectRequired

No field description supplied.

401

A valid developer token is required.

Response headers

WWW-AuthenticatestringOptional

Bearer authentication challenge. A rejected token can include the invalid_token error.

application/json

Uses the same response body schema as HTTP 400.

403

The token lacks the subscription read grant or its issuer lost Space access.

application/json

Uses the same response body schema as HTTP 400.

409

The current subscription requires a billing ownership or configuration review.

application/json

Uses the same response body schema as HTTP 400.

429

The token or Space request budget is exhausted. Edge traffic limits can also return 429.

Response headers

RateLimit-LimitintegerOptional

Per-token capacity in the reported gateway window, expressed in requests of this operation. A shared Space budget also applies. Present when the request reaches the authenticated gateway. Minimum: 1.

RateLimit-RemainingintegerOptional

Requests of this operation remaining under the current token, Space and applicable operation-group quotas. Present when the request reaches the authenticated gateway. Minimum: 0.

RateLimit-ResetintegerOptional

Unix timestamp in seconds when the reported gateway quota resets. Present when the request reaches the authenticated gateway. Minimum: 0.

Retry-AfterintegerOptional

Seconds to wait before retrying, when the limiting policy supplies a retry time. Minimum: 1.

application/json

Uses the same response body schema as HTTP 400.

503

The billing provider or subscription state is temporarily unavailable.

application/json

Uses the same response body schema as HTTP 400.

Was this helpful?