Subscriptions

Change subscription tier or billing cycle

post/v3/subscriptions/{organizationName}/change

Request

  • Base URL: https://api.zephyr-cloud.io
  • URL: https://api.zephyr-cloud.io/v3/subscriptions/{organizationName}/change
  • Auth: HTTP bearer

Path parameters

organizationNamestring required

Organization name

Example:my-org

Request body

newTier'PERSONAL' | 'TEAM' | 'PRO' | 'ENTERPRISE' required

The new subscription tier to change to

newBillingCycle'MONTHLY' | 'YEARLY' required

The new billing cycle

stripePaymentMethodIdstring

Stripe payment method ID for billing

couponstring

Coupon code to apply to this change

Example request

{
  "newTier": "PRO",
  "newBillingCycle": "MONTHLY",
  "stripePaymentMethodId": "pm_1234567890",
  "amounts": {
    "SEATS": 5
  },
  "overages": {
    "DEPLOYMENTS": 5000
  },
  "coupon": "ZEPHYR20"
}

Response

Subscription changed

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Operation completed successfully"
}

Changes

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