Skip to main content
GET
/
contracts
List Contracts
curl --request GET \
  --url https://connect.withvayu.com/contracts \
  --header 'Authorization: Bearer <token>'
{
  "contracts": [
    {
      "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
          },
          "description": "<string>",
          "catalogProductId": "<string>",
          "productErpId": "<string>",
          "nsClass": "<string>",
          "nsClassId": "<string>",
          "commitment": {
            "units": 1,
            "price": 1,
            "scheduling": {
              "duration": {
                "unit": "MONTH",
                "value": 500
              },
              "billingDay": 1
            },
            "overageStrategy": "IGNORE"
          }
        }
      ],
      "productGroups": [
        {
          "displayName": "<string>",
          "products": [
            {
              "displayName": "<string>",
              "scheduling": {
                "duration": {
                  "unit": "MONTH",
                  "value": 500
                },
                "billingDay": 1
              },
              "pricing": {
                "type": "ONE_TIME",
                "price": 1
              },
              "description": "<string>",
              "catalogProductId": "<string>",
              "productErpId": "<string>",
              "nsClass": "<string>",
              "nsClassId": "<string>",
              "commitment": {
                "units": 1,
                "price": 1,
                "scheduling": {
                  "duration": {
                    "unit": "MONTH",
                    "value": 500
                  },
                  "billingDay": 1
                },
                "overageStrategy": "IGNORE"
              }
            }
          ],
          "description": "<string>",
          "productErpId": "<string>",
          "nsClass": "<string>",
          "nsClassId": "<string>",
          "baseAmount": 123,
          "commitment": {
            "units": 1,
            "price": 1,
            "scheduling": {
              "duration": {
                "unit": "MONTH",
                "value": 500
              },
              "billingDay": 1
            },
            "overageStrategy": "IGNORE"
          }
        }
      ],
      "accountManager": "<string>",
      "shouldProRateInvoices": true,
      "autoRenewContract": true
    }
  ],
  "total": 123,
  "hasMore": true,
  "nextCursor": "<string>"
}

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
number
default:10
Required range: 1 <= x <= 1000
cursor
string

Response

RequestSuccess

contracts
object[]
required
total
number
required
hasMore
boolean
required
nextCursor
string