Preview a subscription plan change

View as Markdown

Show what POST /v1/billing/plan-changes would do for the same plan without changing anything: the amount charged on confirmation, when the plan takes effect, the recurring price after it, and the card on file. Refuses exactly what the plan change refuses.

Authentication

AuthorizationBearer
Your aVenture API key (https://aventure.vc/settings/api-keys) or OAuth access token

Request

This endpoint expects an object.
planenumRequired

AI Plus or AI Pro plan to move to; the current plan cancels a scheduled change

Allowed values:

Response headers

X-RateLimit-Limitinteger

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-Remaininginteger

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-Resetinteger

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

OK
amountDuelong

Amount charged on confirmation in the currency’s minor unit, after credit for unused time; 0 when the change waits for the period end

currencystring
ISO 4217 currency code.
effectiveAtdatetime

When the plan would take effect: now, or the current period end

planenum
Plan the subscription would move to
Allowed values:
recurringPriceobject
Recurring charge after the change
paymentMethodobject or nullOptional

Card Stripe charges; absent when no card is on file

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
406
Not Acceptable Error
409
Conflict Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error