Companies

Downgrade a Subscription

Switch a specific child company to the free-tier subscription plan. The free-tier plan takes effect upon expiration of the current plan period.

Required authorization scope: enterprise.company:write

post/2024-11/companies/{easyship_company_id}/downgrade_subscription

Request

  • Base URL
    https://enterprise-api.easyship.com
  • URL
    https://enterprise-api.easyship.com/2024-11/companies/{easyship_company_id}/downgrade_subscription
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://enterprise-api.easyship.com/oauth2/token scopes: enterprise.company

Response

subscription successfully switched to free plan

Example response

{
  "subscription": {
    "subscription_plan": {
      "currency": "USD"
    },
    "next_subscription": {
      "subscription_plan": {
        "currency": "USD"
      }
    }
  }
}

Changes

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