Retrieve a contract

Retrieves the object of an existing contract. You need to pass the unique impact.com campaign Id and contract Id values that were returned when listing contracts.

Parameters


No parameters.

Returns


Returns a contract object if a valid identifier is provided. Returns an error for invalid identifiers.

Example Request


curl 'https://api.impact.com/Advertisers/<AccountSID>/Campaigns/1000/Contracts/S-7777777' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json'

Example Response


{
  "Id": "S-7777777",
  "PartnerId": "10000",
  "PartnerValue1": "",
  "Status": "ACTIVE",
  "StartDate": "2021-01-20T00:00:00-08:00",
  "EndDate": "",
  "BrandSignatory": "Brand Man",
  "BrandSignatoryDate": "2021-01-19T23:51:01-08:00",
  "PartnerSignatory": "Partner Person",
  "PartnerSignatoryDate": "2021-01-19T23:51:01-08:00",
  "DateCreated": "2021-01-19T23:51:01-08:00",
  "DateLastUpdated": "2021-01-19T23:51:01-08:00",
  "TemplateTerms": {
    "TemplateId": "99999",
    "VersionId": "000006",
    "Name": "ACME Public Terms",
    "Labels": [
      "HighestPercent"
      ],
    "Currency": "USD",
    "EventPayouts": [
      {
        "EventTypeId": "18500",
        "EventTypeName": "Online Sale",
        "EventCategory": "SALE",
        "DefaultPayoutRate": "15",
        "PayoutLevel": "ITEM",
        "PayoutGroups": [
          {
            "Id": "ab12c3d4-5e6f-7g89-01h2-345ijk6lmn78",
            "Rank": "1",
            "Rules": [
              {
                "Variable": "CUSTOMER_COUNTRY",
                "Operator": "IS",
                "Values": [
                  "USA"
                  ]
                }
              ],
            "PayoutRate": "15",
            "Limits": [
              {
                "Type": "PAYOUT",
                "Value": "45.0",
                "LimitBy": "ITEM",
                "Period": "DAY"
                }
              ]
            },
          {
            "Id": "90opqrs1-2t34-5678-9012-345u67v890w1",
            "Rank": "2",
            "Rules": [
              {
                "Variable": "ITEM_DISCOUNT",
                "Operator": "IS",
                "Values": [
                  "60"
                  ]
                }
              ],
            "Payout": "15.00"
          }
        ],
        "PayoutAdjustments": [
          {
            "Id": "x234y567-8901-2z3a-4567-8b9012345c67",
            "Rules": [
              {
                "Variable": "CUSTOMER_STATUS",
                "Operator": "IS",
                "Values": [
                  "FREQUENT"
                  ]
                }
              ],
            "Direction": "INCREASE",
            "Rate": "15"
          }
        ],
        "PerformanceBonus": {
          "Type": "ALL_ACTIONS",
          "Basis": "REVENUE",
          "Period": "CALENDAR_MONTH",
          "Tiers": [
            {
              "RevenueThreshold": "15.00",
              "PayoutRate": "60"
              }
            ]
          },
        "PayoutRestrictions": [
          {
            "Id": "8d9012ef-gh34-56i7-jk89-012345l67890",
            "Rules": [
              {
                "Variable": "PATH_MEDIA_COUNT",
                "Operator": "IS",
                "Values": [
                  "50"
                  ]
                }
              ]
            }
          ],
        "Limits": [
          {
            "Type": "ACTION",
            "Value": "100.0",
            "LimitBy": "CUSTOMER",
            "Period": "DAY",
            "WeekendOverrideValue": "500"
            }
          ],
        "Locking": {
          "Basis": "TRACKED",
          "Period": "MONTH",
          "MonthOffset": "1",
          "DayOffset": "0"
          },
        "PayoutScheduling": {
          "Basis": "LOCKED",
          "Period": "END_OF_MONTH"
          },
        "CreditPolicy": "LAST_REFERRER",
          "ValidReferrals": [
            {
              "Type": "CLICKS",
              "Window": "30",
              "WindowUnit": "DAY"
              }
            ]
          }
        ],
      "SpecialTermsList": [
        {
          "TermsName": "Custom Terms",
          "TermsType": "CUSTOM",
          "TermsContent": "<p>These are custom terms</p>\r\n"
          }
        ],
      "ChangeNotificationPeriod": "20",
      "ReturnPolicy": "ALWAYS_OK",
      "MaxReturnPercentage": "100",
      "ActionLimit": "1500",
      "ActionLimitPeriod": "MONTH",
      "SpendLimit": "10000.00",
      "SpendLimitPeriod": "MONTH",
      "MinEarningPerClick": "0.00",
      "ContractStartSlottingFee": "50.00",
      "CustomCreativePayer": "ADVERTISER"
    },
  "PdfUri": "/Advertisers/<AccountSID>/Campaigns/1000/Contracts/S-7777777/Download",
  "Uri": "/Advertisers/<AccountSID>/Campaigns/1000/Contracts/S-7777777"
}