Subscriptions

Change the plan

Apply a plan change quoted by the preview. Echo the preview's prorationDate so the amount charged matches the quote. An upgrade charges the prorated difference on the saved card now and the response carries the new per-cycle amount; a downgrade is scheduled for the current period end (effectiveAt) and charges nothing today. Idempotent on (subscription, target plan, prorationDate). Same plan, a non-active subscription, a different currency, or a different billing interval return 400.

post/gateway/subscriptions/{id}/plan-change

Request

  • Base URL: https://api.agentaos.ai/api/v1
  • URL: https://api.agentaos.ai/api/v1/gateway/subscriptions/{id}/plan-change
  • Auth: API key in header x-api-key

Path parameters

idstring uuid required

Subscription id.

Request body

targetLinkIdstring uuid required

The target product's payment-link id.

prorationDateinteger required

From the preview response.

Response

The applied change. Shape depends on direction.

OR
OR

Changes

No recorded changes to this operation across all 1 revision of this API.