Skip to main content
POST
/
contracts
Create Contract
curl --request POST \
  --url https://connect.withvayu.com/contracts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "startDate": "2023-11-07T05:31:56Z",
  "customerId": "<string>",
  "name": "<string>",
  "salesForceOpportunityId": "<string>",
  "endDate": "2023-11-07T05:31:56Z",
  "signatureDate": "2023-11-07T05:31:56Z",
  "products": [
    {
      "displayName": "<string>",
      "scheduling": {
        "duration": {
          "unit": "MONTH",
          "value": 500
        },
        "billingDay": 1
      },
      "pricing": {
        "type": "ONE_TIME",
        "price": 1,
        "discount": {
          "name": "<string>",
          "amount": 1,
          "recurring": 2
        },
        "isCreditPurchase": true
      },
      "description": "<string>",
      "catalogProductId": "<string>",
      "productErpId": "<string>",
      "nsClass": "<string>",
      "nsClassId": "<string>",
      "commitment": {
        "units": 1,
        "price": 1,
        "type": "UNITS",
        "scheduling": {
          "duration": {
            "unit": "MONTH",
            "value": 500
          },
          "billingDay": 1
        },
        "overageStrategy": "IGNORE"
      },
      "isCalendarAligned": true,
      "cloudProviderSettings": {
        "cloudProvider": "AWS",
        "cloudProviderMarketplaceId": "<string>",
        "dimension": "<string>"
      }
    }
  ],
  "productGroups": [
    {
      "displayName": "<string>",
      "products": [
        {
          "displayName": "<string>",
          "scheduling": {
            "duration": {
              "unit": "MONTH",
              "value": 500
            },
            "billingDay": 1
          },
          "pricing": {
            "type": "ONE_TIME",
            "price": 1,
            "discount": {
              "name": "<string>",
              "amount": 1,
              "recurring": 2
            },
            "isCreditPurchase": true
          },
          "description": "<string>",
          "catalogProductId": "<string>",
          "productErpId": "<string>",
          "nsClass": "<string>",
          "nsClassId": "<string>",
          "commitment": {
            "units": 1,
            "price": 1,
            "type": "UNITS",
            "scheduling": {
              "duration": {
                "unit": "MONTH",
                "value": 500
              },
              "billingDay": 1
            },
            "overageStrategy": "IGNORE"
          },
          "isCalendarAligned": true,
          "cloudProviderSettings": {
            "cloudProvider": "AWS",
            "cloudProviderMarketplaceId": "<string>",
            "dimension": "<string>"
          }
        }
      ],
      "description": "<string>",
      "productErpId": "<string>",
      "nsClass": "<string>",
      "nsClassId": "<string>",
      "baseAmount": 123,
      "commitment": {
        "units": 1,
        "price": 1,
        "type": "UNITS",
        "scheduling": {
          "duration": {
            "unit": "MONTH",
            "value": 500
          },
          "billingDay": 1
        },
        "overageStrategy": "IGNORE"
      },
      "isCalendarAligned": true
    }
  ],
  "accountManager": "<string>",
  "shouldProRateInvoices": true,
  "autoRenewContract": true,
  "customFields": [
    {
      "vayuCustomFieldName": "<string>",
      "fieldPath": "<string>",
      "value": "<unknown>"
    }
  ],
  "customFieldValues": [
    {
      "customFieldDefinitionId": "<string>",
      "value": "<string>",
      "fieldName": "<string>"
    }
  ],
  "purchaseOrder": "<string>"
}
'
{
  "contract": {
    "startDate": "2023-11-07T05:31:56Z",
    "customerId": "<string>",
    "name": "<string>",
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "salesForceOpportunityId": "<string>",
    "endDate": "2023-11-07T05:31:56Z",
    "signatureDate": "2023-11-07T05:31:56Z",
    "products": [
      {
        "displayName": "<string>",
        "scheduling": {
          "duration": {
            "unit": "MONTH",
            "value": 500
          },
          "billingDay": 1
        },
        "pricing": {
          "type": "ONE_TIME",
          "price": 1,
          "discount": {
            "name": "<string>",
            "amount": 1,
            "recurring": 2
          },
          "isCreditPurchase": true
        },
        "description": "<string>",
        "catalogProductId": "<string>",
        "productErpId": "<string>",
        "nsClass": "<string>",
        "nsClassId": "<string>",
        "commitment": {
          "units": 1,
          "price": 1,
          "type": "UNITS",
          "scheduling": {
            "duration": {
              "unit": "MONTH",
              "value": 500
            },
            "billingDay": 1
          },
          "overageStrategy": "IGNORE"
        },
        "isCalendarAligned": true,
        "cloudProviderSettings": {
          "cloudProvider": "AWS",
          "cloudProviderMarketplaceId": "<string>",
          "dimension": "<string>"
        }
      }
    ],
    "productGroups": [
      {
        "displayName": "<string>",
        "products": [
          {
            "displayName": "<string>",
            "scheduling": {
              "duration": {
                "unit": "MONTH",
                "value": 500
              },
              "billingDay": 1
            },
            "pricing": {
              "type": "ONE_TIME",
              "price": 1,
              "discount": {
                "name": "<string>",
                "amount": 1,
                "recurring": 2
              },
              "isCreditPurchase": true
            },
            "description": "<string>",
            "catalogProductId": "<string>",
            "productErpId": "<string>",
            "nsClass": "<string>",
            "nsClassId": "<string>",
            "commitment": {
              "units": 1,
              "price": 1,
              "type": "UNITS",
              "scheduling": {
                "duration": {
                  "unit": "MONTH",
                  "value": 500
                },
                "billingDay": 1
              },
              "overageStrategy": "IGNORE"
            },
            "isCalendarAligned": true,
            "cloudProviderSettings": {
              "cloudProvider": "AWS",
              "cloudProviderMarketplaceId": "<string>",
              "dimension": "<string>"
            }
          }
        ],
        "description": "<string>",
        "productErpId": "<string>",
        "nsClass": "<string>",
        "nsClassId": "<string>",
        "baseAmount": 123,
        "commitment": {
          "units": 1,
          "price": 1,
          "type": "UNITS",
          "scheduling": {
            "duration": {
              "unit": "MONTH",
              "value": 500
            },
            "billingDay": 1
          },
          "overageStrategy": "IGNORE"
        },
        "isCalendarAligned": true
      }
    ],
    "accountManager": "<string>",
    "shouldProRateInvoices": true,
    "autoRenewContract": true,
    "customFields": [
      {
        "vayuCustomFieldName": "<string>",
        "fieldPath": "<string>",
        "value": "<unknown>"
      }
    ],
    "customFieldValues": [
      {
        "customFieldDefinitionId": "<string>",
        "value": "<string>",
        "fieldName": "<string>"
      }
    ],
    "purchaseOrder": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
startDate
string<date-time>
required

The start date of the contract

​
customerId
string
required

The id of the customer that the contract is associated with

Pattern: ^[0-9a-fA-F]{24}$
​
name
string
required

The name of the contract

​
salesForceOpportunityId
string | null

The id of the sales force opportunity that the contract is associated with

​
endDate
string<date-time> | null

The end date of the contract

​
signatureDate
string<date-time> | null

The signature date of the contract

​
products
object[]

The products that the contract is associated with

​
productGroups
object[]

Product groups are list of products that can be grouped as a single line item with shared settings like ERP settings, commitment settings, etc.

​
accountManager
string | null

The name of the account manager of the contract

​
shouldProRateInvoices
boolean
deprecated

Whether to pro rate the invoices for the contract. If not provided, it will default to false

​
autoRenewContract
boolean

Whether the contract is set to auto renew. If not provided, it will be treated as true

​
customFields
object[] | null

Custom fields from CRM systems (Salesforce, HubSpot, etc.)

​
customFieldValues
object[] | null

The stored custom field values associated with the contract

​
status
enum<string>

The status of the contract

Available options:
InReview,
Active,
Inactive,
Expired,
Terminated,
PendingTermination,
Error
​
purchaseOrder
string

The purchase order number of the contract

​
currency
enum<string> | null

The currency of the contract. Overrides the customer-level currency for all invoices under this contract. If not provided, the customer currency or account default (USD) is used.

Available options:
USD,
EUR,
GBP,
ILS,
CAD,
AUD,
COP,
BRL

Response

RequestSuccess

​
contract
object
required