REST API Reference

CMS – Subscriptions

CreateSubscription

CreateSubscription
RequestUri	https://api.cipcert.goevo.com/2.1.28/REST/DataServices/CMS.svc/Subscriptions/
Method	POST
Authentication	Session token set as Username on Authentication header.
Accept	application/json

Request

{
  "Subscription": {
    "Amount": 5.00,
    "Description": "test description 69CB2",
    "MerchantSubscriptionId": "69CB2",
    "StartDate": "2017-03-27T00:00:00-06:00",
    "EndDate": "2018-03-27T00:00:00-06:00",
    "IntervalUnit": "Month",
    "IntervalLength": 1,
    "NextProcessingDate": "2017-03-30T00:00:00-06:00",
    "IntervalCount": 370,
    "TotalTrialInvoices": 0,
    "Order": {
      "BillingData": {
        "Company": "billing data company 69CB2",
        "FirstName": "FirstName_69CB2",
        "LastName": "LastName_69CB2"
      },
      "CurrencyCode": "USD",
      "Description": "order description 69CB2",
      "Tax": {
        "Amount": 0.89,
        "Rate": 0.0081
      },
      "TaxExempt": "NotExemptTaxInfoProvided",
      "OrderTimeStamp": "2017-03-27T10:52:34.5312022-06:00"
    },
    "AutoRenew": true,
    "CustomerReferenceId": "76E9BAF2ECAC4FC9A53DC5C0B466B2DE",
    "PaymentData": {
      "CardType": "Visa",
      "PaymentAccountNumber": "4111111111169085",
      "PaymentAccountExpiration": "0520"
    }
  },
  "MerchantProfileId": "Dev_Test_28",
  "Scope": "MerchantProfileId",
  "ServiceId": "39C6700001",
  "ApplicationProfileId": "772763"
}

Response

CC16ECAE16084A9E953A7A93D20C26D0

GetSubscription

GetSubscription
RequestUri	https://api.cipcert.goevo.com/2.1.28/REST/DataServices/CMS.svc/Subscriptions/[subscriptionId]?merchantProfileId=[merchantProfileId]&scope=MerchantProfileId
Method	GET
Authentication	Session token set as Username on Authentication header.
Accept	application/json

Request

null

Response

 {
  "InvoiceCount": 0,
  "Amount": 5.0,
  "TrialInvoiceCount": 0,
  "Description": null,
  "SubscriptionState": "Pending",
  "MerchantSubscriptionId": "69CB2",
  "Scope": "MerchantProfileId",
  "StartDate": "2017-03-27T06:00:00",
  "CreatedDate": "2017-03-27T16:51:44.22",
  "EndDate": "2018-03-27T06:00:00",
  "LastUpdatedDate": "0001-01-01T00:00:00",
  "IntervalUnit": "Month",
  "ServiceKey": "3303C63450300001",
  "IntervalLength": 1,
  "MerchantProfileId": "Dev_Test_28",
  "NextProcessingDate": "2017-03-30T06:00:00",
  "SubscriptionReferenceId": "CC16ECAE16084A9E953A7A93D20C26D0",
  "IntervalCount": 370,
  "ServiceId": "39C6700001",
  "TotalTrialInvoices": 0,
  "ApplicationProfileId": null,
  "TrialAmount": 0.0,
  "Order": {
    "BillingData": {
      "Company": "billing data company 69CB2",
      "FirstName": "FirstName_69CB2",
      "LastName": "LastName_69CB2",
      "Address": null
    },
    "ShippingData": null,
    "CustomerCode": null,
    "CurrencyCode": "USD",
    "Description": null,
    "Enable3D": false,
    "PromotionCode": null,
    "ShipmentId": null,
    "ShipCode": null,
    "ShippingTotal": 0.0,
    "ShipMethod": null,
    "DiscountTotal": 0.0,
    "DutyAmount": 0.0,
    "SubTotal": 0.0,
    "Tax": {
      "Amount": 0.89,
      "Rate": 0.0081
    },
    "ItemizedTaxes": null,
    "TaxExempt": "NotExemptTaxInfoNotProvided",
    "TaxExemptNumber": null,
    "OrderItems": null,
    "OrderTimeStamp": "2017-03-27T16:51:29.837"
  },
  "AutoRenew": true,
  "CustomerReferenceId": "76E9BAF2ECAC4FC9A53DC5C0B466B2DE",
  "PaymentData": null,
  "EmployeeId": null
}

QuerySubscriptions

QuerySubscriptions
RequestUri	https://api.cipcert.goevo.com/2.1.28/REST/DataServices/CMS.svc/Subscriptions/query
Method	POST
Authentication	Session token set as Username on Authentication header.
Accept	application/json

Request

{
  "QuerySubscriptionParameters": {
    "CreatedDateRange": null,
    "SubscriptionReferenceId": "CC16ECAE16084A9E953A7A93D20C26D0",
    "SubscriptionState": "NotSet",
    "CustomerReferenceId": null,
    "MerchantSubscriptionId": null
  },
  "Scope": "MerchantProfileId",
  "PagingParameters": {
    "Page": 0,
    "PageSize": 10
  },
  "MerchantProfileId": "Dev_Test_28"
}

Response

{
  "Subscriptions": [
    {
      "InvoiceCount": 0,
      "Amount": 5.0,
      "TrialInvoiceCount": 0,
      "Description": null,
      "SubscriptionState": "Pending",
      "MerchantSubscriptionId": "69CB2",
      "Scope": "MerchantProfileId",
      "StartDate": "2017-03-27T06:00:00",
      "CreatedDate": "2017-03-27T16:51:44.22",
      "EndDate": "2018-03-27T06:00:00",
      "LastUpdatedDate": "0001-01-01T00:00:00",
      "IntervalUnit": "Month",
      "ServiceKey": "3303C63450300001",
      "IntervalLength": 1,
      "MerchantProfileId": "Dev_Test_28",
      "NextProcessingDate": "2017-03-30T06:00:00",
      "SubscriptionReferenceId": "CC16ECAE16084A9E953A7A93D20C26D0",
      "IntervalCount": 370,
      "ServiceId": "39C6700001",
      "TotalTrialInvoices": 0,
      "ApplicationProfileId": null,
      "TrialAmount": 0.0,
      "Order": {
        "BillingData": {
          "Company": "billing data company 69CB2",
          "FirstName": "FirstName_69CB2",
          "LastName": "LastName_69CB2",
          "Address": null
        },
        "ShippingData": null,
        "CustomerCode": null,
        "CurrencyCode": "USD",
        "Description": null,
        "Enable3D": false,
        "PromotionCode": null,
        "ShipmentId": null,
        "ShipCode": null,
        "ShippingTotal": 0.0,
        "ShipMethod": null,
        "DiscountTotal": 0.0,
        "DutyAmount": 0.0,
        "SubTotal": 0.0,
        "Tax": {
          "Amount": 0.89,
          "Rate": 0.0081
        },
        "ItemizedTaxes": null,
        "TaxExempt": "NotExemptTaxInfoNotProvided",
        "TaxExemptNumber": null,
        "OrderItems": null,
        "OrderTimeStamp": "2017-03-27T16:51:29.837"
      },
      "AutoRenew": true,
      "CustomerReferenceId": "76E9BAF2ECAC4FC9A53DC5C0B466B2DE",
      "PaymentData": null,
      "EmployeeId": null
    }
  ],
  "PageNumber": 0,
  "TotalPages": 1,
  "TotalFound": 1
}

UpdateSubscription

UpdateSubscription
RequestUri	https://api.cipcert.goevo.com/2.1.28/REST/DataServices/CMS.svc/Subscriptions/[subscriptionId]
Method	PUT
Authentication	Session token set as Username on Authentication header.
Accept	application/json

Request

{
  "Subscription": {
    "Amount": 5.00,
    "Description": "updated subscription",
    "MerchantSubscriptionId": "69CB2",
    "StartDate": "2017-03-27T00:00:00-06:00",
    "EndDate": "2018-07-05T00:00:00-06:00",
    "IntervalUnit": "Week",
    "IntervalLength": 1,
    "NextProcessingDate": "2017-03-30T00:00:00-06:00",
    "IntervalCount": 65,
    "TotalTrialInvoices": 0,
    "Order": {
      "BillingData": {
        "Company": "billing data company 69CB2",
        "FirstName": "FirstName_69CB2",
        "LastName": "LastName_69CB2"
      },
      "CurrencyCode": "USD",
      "Description": "order description 69CB2",
      "Tax": {
        "Amount": 0.89,
        "Rate": 0.0081
      },
      "TaxExempt": "NotExemptTaxInfoNotProvided",
      "OrderTimeStamp": "2017-03-27T10:52:53.7142022-06:00"
    },
    "AutoRenew": true,
    "CustomerReferenceId": "76E9BAF2ECAC4FC9A53DC5C0B466B2DE",
    "PaymentData": {
      "CardType": "Visa",
      "PaymentAccountNumber": "4111111111176411",
      "PaymentAccountExpiration": "0520"
    }
  },
  "MerchantProfileId": "Dev_Test_28",
  "Scope": "MerchantProfileId",
  "ServiceId": "39C6700001",
  "ApplicationProfileId": "772763"
}

UpdateSubscriptionState

UpdateSubscriptionState
RequestUri	https://api.cipcert.goevo.com/2.1.28/REST/DataServices/CMS.svc/Subscriptions/[subscriptionId]/state
Method	PUT
Authentication	Session token set as Username on Authentication header.
Accept	application/json

Request

{
  "MerchantProfileId": "Dev_Test_28",
  "SubscriptionState": "Cancelled"
}

InvoiceSubscription

InvoiceSubscription
RequestUri	https://api.cipcert.goevo.com/2.1.28/REST/DataServices/CMS.svc/Subscriptions/[subscriptionId]/invoice?merchantProfileId=[merchantProfileId]
Method	POST
Authentication	Session token set as Username on Authentication header.
Accept	application/json

Request

null

Response

{
  "InvoiceReferenceId": "CC153859DEB441FAA77C03711051A446",
  "TransactionId": "ECBA5FE45E9C4165814D5B649C0039F0",
  "Status": "Successful",
  "StatusCode": "1",
  "StatusMessage": "Approved - 000:APPROVED"
}

DeleteSubscription

DeleteSubscription
RequestUri	https://api.cipcert.goevo.com/2.1.28/REST/DataServices/CMS.svc/Subscriptions/[subscriptionId]?merchantProfileId=[merchantProfileId]
Method	DELETE
Authentication	Session token set as Username on Authentication header.
Accept	application/json

Request

null