# Change subscription tier

POST //localhost:8080/api/v1/subscriptions/change
Content-Type: application/json

Upgrade or downgrade tier. Owner/billing_admin only. Supports Idempotency-Key. Downgrade with active VKs > new limit returns 409 CONFLICT_VK_QUOTA.

Reference: https://api.alephant.io/api-reference/saa-s-api/subscriptions/change-subscription-tier

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: saas-openapi
  version: 1.0.0
paths:
  /api/v1/subscriptions/change:
    post:
      operationId: change-subscription-tier
      summary: Change subscription tier
      description: >-
        Upgrade or downgrade tier. Owner/billing_admin only. Supports
        Idempotency-Key. Downgrade with active VKs > new limit returns 409
        CONFLICT_VK_QUOTA.
      tags:
        - subpackage_subscriptions
      parameters:
        - name: Authorization
          in: header
          description: Bearer {access_token}
          required: true
          schema:
            type: string
        - name: X-Workspace-Id
          in: header
          description: Workspace UUID
          required: true
          schema:
            type: string
        - name: Idempotency-Key
          in: header
          description: Client UUID for idempotent request
          required: false
          schema:
            type: string
      responses:
        '200':
          description: 'data: updated subscription'
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
        '400':
          description: X-Workspace-Id required
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
        '403':
          description: FORBIDDEN or SUBSCRIPTION_PAST_DUE
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
        '404':
          description: NOT_FOUND
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
        '409':
          description: CONFLICT_VK_QUOTA or IDEMPOTENCY_CONFLICT
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
        '422':
          description: VALIDATION_ERROR (tier/billingPeriod)
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
      requestBody:
        description: >-
          tier (free|pro|team|enterprise|contact), billingPeriod
          (monthly|yearly)
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/internal_api_handlers_subscriptions.ChangeSubscriptionRequest
servers:
  - url: //localhost:8080
components:
  schemas:
    InternalApiHandlersSubscriptionsChangeSubscriptionRequestBillingPeriod:
      type: string
      enum:
        - monthly
        - yearly
      title: InternalApiHandlersSubscriptionsChangeSubscriptionRequestBillingPeriod
    InternalApiHandlersSubscriptionsChangeSubscriptionRequestTier:
      type: string
      enum:
        - free
        - pro
        - team
        - enterprise
        - contact
      title: InternalApiHandlersSubscriptionsChangeSubscriptionRequestTier
    internal_api_handlers_subscriptions.ChangeSubscriptionRequest:
      type: object
      properties:
        billingPeriod:
          $ref: >-
            #/components/schemas/InternalApiHandlersSubscriptionsChangeSubscriptionRequestBillingPeriod
        tier:
          $ref: >-
            #/components/schemas/InternalApiHandlersSubscriptionsChangeSubscriptionRequestTier
      required:
        - billingPeriod
        - tier
      title: internal_api_handlers_subscriptions.ChangeSubscriptionRequest

```

## SDK Code Examples

```python
import requests

url = "https://localhost:8080/api/v1/subscriptions/change"

payload = {
    "billingPeriod": "monthly",
    "tier": "free"
}
headers = {
    "Authorization": "Authorization",
    "X-Workspace-Id": "X-Workspace-Id",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://localhost:8080/api/v1/subscriptions/change';
const options = {
  method: 'POST',
  headers: {
    Authorization: 'Authorization',
    'X-Workspace-Id': 'X-Workspace-Id',
    'Content-Type': 'application/json'
  },
  body: '{"billingPeriod":"monthly","tier":"free"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://localhost:8080/api/v1/subscriptions/change"

	payload := strings.NewReader("{\n  \"billingPeriod\": \"monthly\",\n  \"tier\": \"free\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Authorization")
	req.Header.Add("X-Workspace-Id", "X-Workspace-Id")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://localhost:8080/api/v1/subscriptions/change")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Authorization'
request["X-Workspace-Id"] = 'X-Workspace-Id'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"billingPeriod\": \"monthly\",\n  \"tier\": \"free\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://localhost:8080/api/v1/subscriptions/change")
  .header("Authorization", "Authorization")
  .header("X-Workspace-Id", "X-Workspace-Id")
  .header("Content-Type", "application/json")
  .body("{\n  \"billingPeriod\": \"monthly\",\n  \"tier\": \"free\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://localhost:8080/api/v1/subscriptions/change', [
  'body' => '{
  "billingPeriod": "monthly",
  "tier": "free"
}',
  'headers' => [
    'Authorization' => 'Authorization',
    'Content-Type' => 'application/json',
    'X-Workspace-Id' => 'X-Workspace-Id',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://localhost:8080/api/v1/subscriptions/change");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Authorization");
request.AddHeader("X-Workspace-Id", "X-Workspace-Id");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"billingPeriod\": \"monthly\",\n  \"tier\": \"free\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Authorization",
  "X-Workspace-Id": "X-Workspace-Id",
  "Content-Type": "application/json"
]
let parameters = [
  "billingPeriod": "monthly",
  "tier": "free"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://localhost:8080/api/v1/subscriptions/change")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```