Skip to navigation

Cancel or Resume the Subscription

View as Markdown

Set cancelAtPeriodEnd to true to end an active AI Plus or AI Pro subscription at the current period end; a scheduled plan change is dropped. Set it to false to resume the subscription and restore the plan change scheduled before the cancellation. Read the result with GET /v1/billing/subscription.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
cancelAtPeriodEndboolean or nullOptional

true ends the subscription at the current period end and drops a scheduled plan change; false resumes it and restores the plan change scheduled before the cancellation. Omit to change nothing.

Response

No Content

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