billing

Switch Subscription Plan

Switch to a different subscription plan. Upgrades are applied immediately with proration, downgrades are scheduled for period end.

post/billing/subscription/switch

Request

  • Base URL: https://api.aiapplyd.com/api/v1
  • URL: https://api.aiapplyd.com/api/v1/billing/subscription/switch
  • Auth: HTTP bearer

Request body

interval'week' | 'month' | 'year'

Intended billing interval. When supplied, the server re-resolves newPriceId to the plan's price for this interval, so the cadence actually billed always matches the cadence the user was quoted.

newPriceIdstring required

New Stripe price ID to switch to (handles both upgrades and downgrades automatically). Prefer sending interval alongside it — this id may be the plan's ambiguous weekly primary.

Example request

{
  "interval": "month",
  "newPriceId": "price_1234567890"
}

Response

Subscription switched successfully

SwitchSubscriptionResponse required(unresolved $ref)

Changes

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