---
title: "Purchase Plan"
method: POST
path: "/v3.0/businesses/{slug}/upgrade/"
tags: ["businesses"]
---

# Purchase Plan

`POST /v3.0/businesses/{slug}/upgrade/`

## Request

- Base URL: `https://api.formaloo.me`
- URL: `https://api.formaloo.me/v3.0/businesses/{slug}/upgrade/`
- Auth: none declared. Required headers: `x-api-key`

## Path parameters

- `slug` string, required

## Headers

- `x-api-key` string, required

## Request body

- PurchasePlanRequest
  - `plan_deal` string, nullable
  - `coupon_code` string, nullable
  - `addon_packages` string[]: send any addon package user want to purchase along with the plan deal.
  - `company_name` string: name of the company
  - `company_country` string, nullable: country of the company
  - `company_city` string: city of the company
  - `company_region` string: state/region of the company
  - `company_postal_code` string: postal code of the company
  - `company_address_line_1` string: address of the company, line 1.
  - `company_address_line_2` string: address of the company, line 2.
  - `company_vat` string: vat number of the company

## Response `201`

- PurchasePlan
  - `plan_deal` string, nullable
  - `coupon_code` string, nullable
  - `link` string, uri
  - `has_company_info` boolean: does this purchase send the business' company info to payment gateway?
  - `addon_packages` string[]: send any addon package user want to purchase along with the plan deal.
  - `is_trial` boolean: is this a trial plan?
  - `company_name` string: name of the company
  - `company_country` string, nullable: country of the company
  - `company_city` string: city of the company
  - `company_region` string: state/region of the company
  - `company_postal_code` string: postal code of the company
  - `company_address_line_1` string: address of the company, line 1.
  - `company_address_line_2` string: address of the company, line 2.
  - `company_vat` string: vat number of the company

---

[API](https://skmtc.dev/formaloo/apis/formaloo-api-documentation.md) · [All operations](https://skmtc.dev/formaloo/apis/formaloo-api-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/formaloo/apis/formaloo-api-documentation/revisions/47b268aeb656?raw)
