EZezypay

Cancel a partner subscription

Changed on

Cancel an existing partner subscription.

put/partnersubscriptions/{partnerSubscriptionId}/cancel

Request

  • Base URL
    https://api-sandbox.ezypay.com/v2
  • URL
    https://api-sandbox.ezypay.com/v2/partnersubscriptions/{partnerSubscriptionId}/cancel
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://identity-sandbox.ezypay.com/token

Path parameters

partnerSubscriptionIdstring required

Auto-generated unique identifier of the partner subscription.

Headers

merchantstring required

Merchant ID

Response

200

idstring
partnerPlanIdstring
namestring
statusstring
accountingCodestring
intervalUnitstring
intervalinteger
intervalDayTypestring
endTypestring
startDatestring
endDateunknown
nextBillingDateunknown
merchantConnectionIdstring
endTargetBillingCyclesinteger
totalBillingCyclesinteger
remainingBillingCyclesinteger
createdOnstring
cancellationDatestring
setupPaymentsunknown

Example response

{
  "id": "315107b6-e341-45c6-ad47-8d0bce9e0b25",
  "partnerPlanId": "26b4bb23-e6cd-401b-8014-5b20093ac7ee",
  "issuer": {
    "id": "eab7bfc6-113a-4e51-aedd-f6a807420656",
    "name": "pnb_ibjl NameNZ",
    "legalName": "pnb_ibjl LegalNameNZ"
  },
  "recipient": {
    "id": "c74437ba-e204-46fc-9b16-0062f896e01e",
    "name": "high_st NameNZ",
    "legalName": "high_st LegalNameNZ"
  },
  "name": "PNB_IBJL_Equipment_Leasing",
  "status": "CANCELLED",
  "amount": {
    "currency": "NZD",
    "value": 10,
    "type": "PERCENTAGE"
  },
  "accountingCode": "EquipmentLeasing",
  "intervalUnit": "MONTH",
  "interval": 1,
  "intervalDayType": "business",
  "endType": "ONGOING",
  "startDate": "2019-04-04",
  "merchantConnectionId": "dae89c35-246c-4551-83b6-addd94853afb",
  "createdOn": "2019-03-11T07:23:33.851",
  "cancellationDate": "2019-07-01"
}

Changes