Create an addon

JavaScript

import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

const addon = await client.v1.addons.create({
  id: 'id',
  displayName: 'displayName',
  productId: 'productId',
});

console.log(addon.data);

import os
from stigg import Stigg

client = Stigg(
    api_key=os.environ.get("STIGG_API_KEY"),  # This is the default and can be omitted
)
addon = client.v1.addons.create(
    id="id",
    display_name="displayName",
    product_id="productId",
)
print(addon.data)

package main

import (
	"context"
	"fmt"

	"github.com/stiggio/stigg-go"
	"github.com/stiggio/stigg-go/option"
)

func main() {
	client := stigg.NewClient(
		option.WithAPIKey("My API Key"),
	)
	addon, err := client.V1.Addons.New(context.TODO(), stigg.V1AddonNewParams{
		ID:          "id",
		DisplayName: "displayName",
		ProductID:   "productId",
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", addon.Data)
}

package io.stigg.example;

import io.stigg.client.StiggClient;
import io.stigg.client.okhttp.StiggOkHttpClient;
import io.stigg.models.v1.addons.Addon;
import io.stigg.models.v1.addons.AddonCreateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        StiggClient client = StiggOkHttpClient.fromEnv();

        AddonCreateParams params = AddonCreateParams.builder()
            .id("id")
            .displayName("displayName")
            .productId("productId")
            .build();
        Addon addon = client.v1().addons().create(params);
    }
}

using System;
using Stigg.Client;
using Stigg.Client.Models.V1.Addons;

StiggClient client = new();

AddonCreateParams parameters = new()
{
    ID = "id",
    DisplayName = "displayName",
    ProductID = "productId",
};

var addon = await client.V1.Addons.Create(parameters);

Console.WriteLine(addon);

curl --request POST \
  --url https://api.stigg.io/api/v1/addons \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "id": "<string>",
  "displayName": "<string>",
  "productId": "<string>",
  "description": "<string>",
  "billingId": "<string>",
  "maxQuantity": 1,
  "metadata": {}
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.stigg.io/api/v1/addons",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '<string>',
    'displayName' => '<string>',
    'productId' => '<string>',
    'description' => '<string>',
    'billingId' => '<string>',
    'maxQuantity' => 1,
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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;
}

{
  "data": {
    "id": "addon-extra-seats",
    "displayName": "Extra Seats",
    "description": "Additional team member seats",
    "productId": "product-starter",
    "status": "PUBLISHED",
    "pricingType": "PAID",
    "billingId": "price_1234567890",
    "versionNumber": 1,
    "isLatest": true,
    "entitlements": [
      {
        "type": "FEATURE",
        "id": "feature-advanced-analytics"
      },
      {
        "type": "CREDIT",
        "id": "api-calls"
      }
    ],
    "metadata": {},
    "createdAt": "2025-10-26T10:00:00.000Z",
    "updatedAt": "2025-10-26T10:00:00.000Z",
    "maxQuantity": 100,
    "dependencies": [
      "addon-premium-support"
    ]
  }
}

{
  "message": "<string>",
  "code": "BadUserInput",
  "reason": "<string>"
}

{
  "message": "<string>",
  "code": "Unauthenticated"
}

{
  "message": "<string>",
  "code": "IdentityForbidden"
}

{
  "message": "<string>",
  "code": "DuplicatedEntityNotAllowed"
}

{
  "message": "<string>",
  "code": "RateLimitExceeded"
}

POST

api

addons

JavaScript

import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

const addon = await client.v1.addons.create({
  id: 'id',
  displayName: 'displayName',
  productId: 'productId',
});

console.log(addon.data);

import os
from stigg import Stigg

client = Stigg(
    api_key=os.environ.get("STIGG_API_KEY"),  # This is the default and can be omitted
)
addon = client.v1.addons.create(
    id="id",
    display_name="displayName",
    product_id="productId",
)
print(addon.data)

package main

import (
	"context"
	"fmt"

	"github.com/stiggio/stigg-go"
	"github.com/stiggio/stigg-go/option"
)

func main() {
	client := stigg.NewClient(
		option.WithAPIKey("My API Key"),
	)
	addon, err := client.V1.Addons.New(context.TODO(), stigg.V1AddonNewParams{
		ID:          "id",
		DisplayName: "displayName",
		ProductID:   "productId",
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", addon.Data)
}

package io.stigg.example;

import io.stigg.client.StiggClient;
import io.stigg.client.okhttp.StiggOkHttpClient;
import io.stigg.models.v1.addons.Addon;
import io.stigg.models.v1.addons.AddonCreateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        StiggClient client = StiggOkHttpClient.fromEnv();

        AddonCreateParams params = AddonCreateParams.builder()
            .id("id")
            .displayName("displayName")
            .productId("productId")
            .build();
        Addon addon = client.v1().addons().create(params);
    }
}

using System;
using Stigg.Client;
using Stigg.Client.Models.V1.Addons;

StiggClient client = new();

AddonCreateParams parameters = new()
{
    ID = "id",
    DisplayName = "displayName",
    ProductID = "productId",
};

var addon = await client.V1.Addons.Create(parameters);

Console.WriteLine(addon);

curl --request POST \
  --url https://api.stigg.io/api/v1/addons \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "id": "<string>",
  "displayName": "<string>",
  "productId": "<string>",
  "description": "<string>",
  "billingId": "<string>",
  "maxQuantity": 1,
  "metadata": {}
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.stigg.io/api/v1/addons",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '<string>',
    'displayName' => '<string>',
    'productId' => '<string>',
    'description' => '<string>',
    'billingId' => '<string>',
    'maxQuantity' => 1,
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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;
}

{
  "data": {
    "id": "addon-extra-seats",
    "displayName": "Extra Seats",
    "description": "Additional team member seats",
    "productId": "product-starter",
    "status": "PUBLISHED",
    "pricingType": "PAID",
    "billingId": "price_1234567890",
    "versionNumber": 1,
    "isLatest": true,
    "entitlements": [
      {
        "type": "FEATURE",
        "id": "feature-advanced-analytics"
      },
      {
        "type": "CREDIT",
        "id": "api-calls"
      }
    ],
    "metadata": {},
    "createdAt": "2025-10-26T10:00:00.000Z",
    "updatedAt": "2025-10-26T10:00:00.000Z",
    "maxQuantity": 100,
    "dependencies": [
      "addon-premium-support"
    ]
  }
}

{
  "message": "<string>",
  "code": "BadUserInput",
  "reason": "<string>"
}

{
  "message": "<string>",
  "code": "Unauthenticated"
}

{
  "message": "<string>",
  "code": "IdentityForbidden"
}

{
  "message": "<string>",
  "code": "DuplicatedEntityNotAllowed"
}

{
  "message": "<string>",
  "code": "RateLimitExceeded"
}

Authorizations

X-API-KEY

string

header

required

Server API Key

Headers

X-ACCOUNT-ID

string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID

string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Body

application/json

Request to create a new addon

string

required

The unique identifier for the entity

Required string length: 1 - 255

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$

displayName

string

required

The display name of the package

Maximum string length: 255

productId

string

required

The product id of the package

Required string length: 1 - 255

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$

description

string | null

The description of the package

Maximum string length: 255

pricingType

enum<string> | null

The pricing type of the package

Available options:

FREE,

PAID,

CUSTOM

billingId

string | null

The unique identifier for the entity in the billing provider

Maximum string length: 255

maxQuantity

integer | null

The maximum quantity of this addon that can be added to a subscription. Leave unset for no upper bound.

Required range: x > 0

status

enum<string>

The status of the package

Available options:

DRAFT,

PUBLISHED,

ARCHIVED

metadata

object

Metadata associated with the entity

Show child attributes

Response

The newly created addon object.

Response object

data

Addon · object

required

Addon configuration object

Show child attributes

Get started

Essentials

Subscriptions

Bulk Import

Usage

Coupons

Products

Features

Addons

Plans

Promotional Entitlements

Customers

Customer Integrations

Data Export

Entitlements

Plan Entitlements

Addon Entitlements

Credit grants

Credit consumption

Credit usage

Auto recharge

Custom currencies

Credit ledger

Contracts

Invoices

Governance Entity Types

Governance Entities

Governance Assignments

Governance Hierarchy

Governance Entitlements Check

Create an addon

Authorizations

Headers

Body

Response