v1

latestOpenAPI 3.1.02026-07-241660500.9 KB

Get a Contract's Payments

Gets payments related to a contract

get/v3/contract/payment

Query parameters

idstring required

Contract Id

subscriptionIdstring

SubscriptionId

limitinteger

offsetinteger

Response

200

idinteger

contractIdinteger

startDatestring

invoiceMethodstring

cardAccountIdinteger

allowPartialPaymentboolean

statusstring

remindBeforeDueDateinteger

remindAfterDueDateinteger

createdstring

modifiedstring

customerIdinteger

billingAddressIdinteger

shippingAddressIdinteger

allowCreditCardboolean

allowACHboolean

sendReceiptstring

eftAgreementRequestedboolean

Example response

[
  {
    "id": 10000000019774,
    "contractId": 10000000020023,
    "startDate": "2018-08-13T04:00:00Z",
    "invoiceMethod": "AutoPay",
    "cardAccountId": 3231695,
    "status": "Active",
    "remindBeforeDueDate": 3,
    "remindAfterDueDate": 3,
    "created": "2018-08-13T19:24:05.883Z",
    "modified": "2018-08-13T19:24:05.883Z",
    "customerId": 3607931,
    "billingAddressId": -1,
    "shippingAddressId": -1,
    "sendReceipt": "Always"
  }
]