Fetch plan instance

curl --request GET \
  --url https://api.useaira.com/v1/plan-instances/{id} \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.useaira.com/v1/plan-instances/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.useaira.com/v1/plan-instances/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.useaira.com/v1/plan-instances/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.useaira.com/v1/plan-instances/{id}")

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

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "activePlanInstanceVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "activePlanVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "plan": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "activePlanInstanceVersion": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "planInstanceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "planVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "versionNumber": 2,
    "isActive": true,
    "metadata": {
      "reason": "created_from_plan_version",
      "sourcePlanVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "planCharges": [
      {
        "category": "fixed",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "position": 1,
        "itemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "isCustomNameEnabled": true,
        "pricingModel": "fixed",
        "pricing": {
          "model": "fixed",
          "amount": 1
        }
      }
    ]
  }
}

{
  "message": "<string>"
}

GET

plan-instances

{id}

Fetch plan instance

curl --request GET \
  --url https://api.useaira.com/v1/plan-instances/{id} \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.useaira.com/v1/plan-instances/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.useaira.com/v1/plan-instances/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.useaira.com/v1/plan-instances/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.useaira.com/v1/plan-instances/{id}")

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

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "activePlanInstanceVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "activePlanVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "plan": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "activePlanInstanceVersion": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "planInstanceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "planVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "versionNumber": 2,
    "isActive": true,
    "metadata": {
      "reason": "created_from_plan_version",
      "sourcePlanVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "planCharges": [
      {
        "category": "fixed",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "position": 1,
        "itemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "isCustomNameEnabled": true,
        "pricingModel": "fixed",
        "pricing": {
          "model": "fixed",
          "amount": 1
        }
      }
    ]
  }
}

{
  "message": "<string>"
}

Authorizations

X-API-KEY

string

header

required

API Key Authentication.

Path Parameters

string<uuid>

required

The unique identifier of the plan instance in our system.

Response

Schema representing a plan instance: a plan sold on a contract. The instance keeps its own versioned copy of the plan's charges, so its pricing can be overridden without affecting the plan or other contracts.

string<uuid>

required

The unique identifier of the plan instance in our system.

contractId

string<uuid>

required

The unique identifier of the contract the plan instance belongs to.

planId

string<uuid>

required

The unique identifier of the plan this instance was created from.

activePlanInstanceVersionId

string<uuid>

required

The unique identifier of the plan instance version currently used for billing.

activePlanVersionId

string<uuid>

required

The unique identifier of the plan version the active plan instance version derives from.

activePlanInstanceVersionReason

enum<string>

required

Why the active plan instance version exists: created_from_plan_version (instantiated from the plan's version), duplicated_from_contract (copied when the contract was duplicated), manual_override (pricing overridden manually or through the API), readjustment (a percentage rate adjustment was applied), or rollback (rolled back to a previous version).

Available options:

created_from_plan_version,

duplicated_from_contract,

manual_override,

readjustment,

rollback

status

enum<string>

required

Current status of the plan instance: active (billed on the contract's cycles), canceled (interrupted before its end; no longer billed), or completed (ran through its end).

Available options:

active,

canceled,

completed

plan

object

required

Base properties of the plan this instance was created from.

Show child attributes

activePlanInstanceVersion

object

required

The plan instance version currently used for billing, including its plan charges.

Show child attributes