Skip to main content
POST
/
v1
/
plan-instances
Create plan instance
curl --request POST \
  --url https://api.useaira.com/v1/plan-instances/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z"
}
'
{
  "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",
    "planSettingsId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "versionNumber": 2,
    "isActive": true,
    "metadata": {
      "sourcePlanVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "planSettings": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "fixedAmount": 1,
      "minimumAmount": 1,
      "metrics": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "currencyUnitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "fixedAmount": 1,
          "minimumAmount": 1,
          "resource": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "itemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "currencyUnit": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "code": "<string>"
          },
          "priceTiers": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "from": 2,
              "to": 2,
              "packageSize": 2,
              "price": "<string>",
              "fixedPrice": "<string>",
              "basisPoints": 1
            }
          ]
        }
      ]
    }
  }
}

Authorizations

​
X-API-KEY
string
header
required

API Key Authentication.

Body

application/json
​
planId
string<uuid>
required
​
contractId
string<uuid>
required
​
startDate
string<date-time>
​
endDate
string<date-time>

Response

Schema representing a plan instance.

​
id
string<uuid>
required
​
contractId
string<uuid>
required
​
planId
string<uuid>
required
​
activePlanInstanceVersionId
string<uuid>
required
​
activePlanVersionId
string<uuid>
required
​
activePlanInstanceVersionReason
enum<string>
required
Available options:
created_from_plan_version,
duplicated_from_contract,
manual_override,
readjustment,
rollback
​
status
enum<string>
required
Available options:
active,
canceled,
completed
​
plan
object
required

Plan core schema defining plan base properties.

​
activePlanInstanceVersion
object
required