v1

latestOpenAPI 3.1.02026-07-241660500.9 KB

Get a Contract

Gets information about the contract

get/v3/contract/{contractId}

Path parameters

contractIdinteger required

Response

200

idinteger

merchantIdinteger

namestring

memostring

termsstring

intervalstring

frequencyinteger

weekDaystring

monthstring

dayNumberinteger

dayTypestring

daystring

totalAmountstring

subTotalAmountstring

discountAmountstring

subscriptionCountinteger

canDeleteboolean

paymentTermstring

Example response

{
  "id": 10000000020023,
  "merchantId": 110070419,
  "name": "Monthly Contract",
  "terms": "OnReceipt",
  "interval": "Monthly",
  "frequency": 1,
  "weekDay": "Sunday",
  "month": "January",
  "dayNumber": 15,
  "dayType": "Day",
  "day": "Sunday",
  "purchases": [
    {
      "id": 111105,
      "productName": "Test Product",
      "quantity": 1,
      "price": "0.01",
      "discountAmount": "0",
      "priceDiscountAmount": "0",
      "subTotalAmount": "0.01",
      "taxAmount": "0"
    }
  ],
  "totalAmount": "0.01",
  "subTotalAmount": "0.01",
  "discountAmount": "0",
  "subscriptionCount": 1,
  "paymentTerm": "OnReceipt"
}