Create contract

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 contract = await client.v1.contracts.create({ customerId: 'customerId' });

console.log(contract.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
)
contract = client.v1.contracts.create(
    customer_id="customerId",
)
print(contract.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"),
	)
	contract, err := client.V1.Contracts.New(context.TODO(), stigg.V1ContractNewParams{
		CustomerID: "customerId",
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", contract.Data)
}

package io.stigg.example;

import io.stigg.client.StiggClient;
import io.stigg.client.okhttp.StiggOkHttpClient;
import io.stigg.models.v1.contracts.ContractCreateParams;
import io.stigg.models.v1.contracts.ContractCreateResponse;

public final class Main {
    private Main() {}

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

        ContractCreateParams params = ContractCreateParams.builder()
            .customerId("customerId")
            .build();
        ContractCreateResponse contract = client.v1().contracts().create(params);
    }
}

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

StiggClient client = new();

ContractCreateParams parameters = new() { CustomerID = "customerId" };

var contract = await client.V1.Contracts.Create(parameters);

Console.WriteLine(contract);

curl --request POST \
  --url https://api.stigg.io/api/v1/contracts \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "customerId": "<string>",
  "contractId": "<string>",
  "name": "<string>",
  "poNumber": "<string>",
  "activationStartDate": "2023-11-07T05:31:56Z",
  "activationEndDate": "2023-11-07T05:31:56Z",
  "setupBilling": true,
  "subscriptions": []
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.stigg.io/api/v1/contracts",
  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([
    'customerId' => '<string>',
    'contractId' => '<string>',
    'name' => '<string>',
    'poNumber' => '<string>',
    'activationStartDate' => '2023-11-07T05:31:56Z',
    'activationEndDate' => '2023-11-07T05:31:56Z',
    'setupBilling' => true,
    'subscriptions' => [
        
    ]
  ]),
  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": {
    "contractId": "contract-acme-2026",
    "billingId": "ct_1a2b3c4d",
    "id": "3452155b-deca-4d7f-91e5-82d486dc8bb0",
    "refId": "contract-acme-2026",
    "poNumber": "PO-4821",
    "externalId": "contract-acme-2026",
    "customerExternalId": "customer-acme",
    "name": "PO-4821",
    "state": "ACTIVE",
    "billingState": "ACTIVE",
    "activationStartDate": "2026-01-01T00:00:00.000Z",
    "activationEndDate": "2026-12-31T00:00:00.000Z",
    "createdAt": "2025-12-15T09:30:00.000Z",
    "nextInvoice": {
      "invoiceId": "a3f1c2de-5b47-4c8e-9f10-2d6b8e4a7c31",
      "amount": {
        "amount": 4900,
        "currency": "usd"
      },
      "dueDate": "2026-08-01T00:00:00.000Z",
      "periodStart": "2026-07-01T00:00:00.000Z",
      "periodEnd": "2026-08-01T00:00:00.000Z"
    },
    "latestInvoice": {
      "billingId": "inv_abc123",
      "status": "OPEN",
      "createdAt": "2026-07-01T00:00:00.000Z",
      "total": 4900,
      "amountDue": 4900,
      "currency": "usd",
      "pdfUrl": null,
      "requiresAction": false,
      "billingReason": null
    },
    "subscriptions": [
      {
        "subscriptionId": "subscription-acme-platform",
        "planDisplayName": "Enterprise Platform",
        "productDisplayName": "Revvenu"
      }
    ]
  }
}

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

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

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

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

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

POST

api

contracts

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 contract = await client.v1.contracts.create({ customerId: 'customerId' });

console.log(contract.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
)
contract = client.v1.contracts.create(
    customer_id="customerId",
)
print(contract.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"),
	)
	contract, err := client.V1.Contracts.New(context.TODO(), stigg.V1ContractNewParams{
		CustomerID: "customerId",
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", contract.Data)
}

package io.stigg.example;

import io.stigg.client.StiggClient;
import io.stigg.client.okhttp.StiggOkHttpClient;
import io.stigg.models.v1.contracts.ContractCreateParams;
import io.stigg.models.v1.contracts.ContractCreateResponse;

public final class Main {
    private Main() {}

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

        ContractCreateParams params = ContractCreateParams.builder()
            .customerId("customerId")
            .build();
        ContractCreateResponse contract = client.v1().contracts().create(params);
    }
}

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

StiggClient client = new();

ContractCreateParams parameters = new() { CustomerID = "customerId" };

var contract = await client.V1.Contracts.Create(parameters);

Console.WriteLine(contract);

curl --request POST \
  --url https://api.stigg.io/api/v1/contracts \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "customerId": "<string>",
  "contractId": "<string>",
  "name": "<string>",
  "poNumber": "<string>",
  "activationStartDate": "2023-11-07T05:31:56Z",
  "activationEndDate": "2023-11-07T05:31:56Z",
  "setupBilling": true,
  "subscriptions": []
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.stigg.io/api/v1/contracts",
  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([
    'customerId' => '<string>',
    'contractId' => '<string>',
    'name' => '<string>',
    'poNumber' => '<string>',
    'activationStartDate' => '2023-11-07T05:31:56Z',
    'activationEndDate' => '2023-11-07T05:31:56Z',
    'setupBilling' => true,
    'subscriptions' => [
        
    ]
  ]),
  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": {
    "contractId": "contract-acme-2026",
    "billingId": "ct_1a2b3c4d",
    "id": "3452155b-deca-4d7f-91e5-82d486dc8bb0",
    "refId": "contract-acme-2026",
    "poNumber": "PO-4821",
    "externalId": "contract-acme-2026",
    "customerExternalId": "customer-acme",
    "name": "PO-4821",
    "state": "ACTIVE",
    "billingState": "ACTIVE",
    "activationStartDate": "2026-01-01T00:00:00.000Z",
    "activationEndDate": "2026-12-31T00:00:00.000Z",
    "createdAt": "2025-12-15T09:30:00.000Z",
    "nextInvoice": {
      "invoiceId": "a3f1c2de-5b47-4c8e-9f10-2d6b8e4a7c31",
      "amount": {
        "amount": 4900,
        "currency": "usd"
      },
      "dueDate": "2026-08-01T00:00:00.000Z",
      "periodStart": "2026-07-01T00:00:00.000Z",
      "periodEnd": "2026-08-01T00:00:00.000Z"
    },
    "latestInvoice": {
      "billingId": "inv_abc123",
      "status": "OPEN",
      "createdAt": "2026-07-01T00:00:00.000Z",
      "total": 4900,
      "amountDue": 4900,
      "currency": "usd",
      "pdfUrl": null,
      "requiresAction": false,
      "billingReason": null
    },
    "subscriptions": [
      {
        "subscriptionId": "subscription-acme-platform",
        "planDisplayName": "Enterprise Platform",
        "productDisplayName": "Revvenu"
      }
    ]
  }
}

{
  "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

Input for creating a contract and its subscriptions atomically.

customerId

string

required

The customer ref ID the contract belongs to

Required string length: 1 - 255

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

contractId

string

Your own ID for the contract, which makes this call idempotent: sending the same one again returns the existing contract instead of creating a second. Omit it and one is generated for you, but then a retry cannot be told apart from a new contract — and contracts cannot be deleted. Recommended whenever a retry is possible, e.g. building a contract from an order form.

Required string length: 1 - 255

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

name

string | null

Optional contract name

Maximum string length: 255

poNumber

string | null

Optional purchase-order number

Maximum string length: 255

activationStartDate

string<date-time>

Optional contract activation start date

activationEndDate

string<date-time>

Optional contract activation end date

setupBilling

boolean

default:true

Whether to set up billing for the contract by creating a billing contract in the connected billing provider. When false, the contract only provisions access (grants entitlements) and no billing contract is created. Defaults to true.

subscriptions

ContractSubscriptionEntry · object[]

The subscriptions to attach to the contract. Each entry is either a new subscription to create or a reference to an existing custom subscription. Optional — omit it (or pass an empty list) to create a contract with no subscriptions and attach them later.

Show child attributes

Response

The created contract, including the custom subscriptions attached to it.

Response object

data

Contract · object

required

A billing contract as reported by the connected billing provider.

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 contract

Authorizations

Headers

Body

Response