Partners

Change a domain's plan

Move one domain to Starter, Growth, Pro or Business. The plan sets the domain's price and the storage its mailboxes, contacts and Drive share. Upgrades apply at once; a downgrade is refused with 409 PLAN_DOES_NOT_FIT while the domain stores more than the new plan holds, or its storage cap or mailbox quotas would not fit. The domain's plan line follows on the next sync. Requires partner:write.

post/customers/{id}/domains/{domain}/plan

Request

  • Base URL: https://faivelo.com/api/partner
  • URL: https://faivelo.com/api/partner/customers/{id}/domains/{domain}/plan
  • Auth: HTTP bearer

Path parameters

idstring required
Example:cmtumr8yj000bd7xabjjsnil8

The customer id returned when the customer was created

domainstring required

The customer's domain name, e.g. smiledental.example

Request body

plan'STARTER' | 'GROWTH' | 'PRO' | 'BUSINESS' required

Response

The new plan

successboolean

Example response

{
  "success": true
}

Changes

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