Contract endpoint

This topic provides a quick reference for the method signatures of contract API methods.

Location: http://smile.example.com:port/stage/smile/ws/v2/contract

WSDL: http://smile.example.com:port/stage/smile/ws/v2/contract?wsdl

Table 1. Contract API methods
Method	Method signature	Purpose
addSubscriptionContract()	`SubscriptionContract addSubscriptionContract( string usn, int contractId, dateTime startDate, dateTime endDate)`	Adds a contract to a subscription.
commitContractTermination()	`SubscriptionContractTerminationResponse commitContractTermination( string usn, SubscriptionContractTerminationOffer subscriptionContractTerminationOffer)`	Terminate a contract on a subscription.
getActiveSubscriptionContract()	`SubscriptionContract getActiveSubscriptionContract( string usn, dateTime when)`	Returns details about a contract on a subscription.
getAvailableContractsForPlan()	`PlanContractDescriptionList getAvailableContractsForPlan( int company, int plan, dateTime when)`	Returns contracts available to subscriptions on a particular plan.
getContractsForService()	`ContractDescriptionList getContractsForService( int sid)`	Returns contracts on a particular service.
getCurrentSubscriptionContract()	`SubscriptionContract getCurrentSubscriptionContract( string usn)`	Returns the current contract for a subscription.
getSubscriptionContractById()	`SubscriptionContract getSubscriptionContractById( string subscriptionContractId)`	Returns a subscription contract by ID.
getSubscriptionContracts()	`SubscriptionContractList getSubscriptionContracts( string usn)`	Returns a lists of all contracts for a subscription.
proposeContractTermination()	`SubscriptionContractTerminationOffer proposeContractTermination( string usn, int subscriptionContractId, dateTime terminationDate)`	Propose a contract termination on a subscription.
updateSubscriptionContract()	`void updateSubscriptionContract( string usn, SubscriptionContract subscriptionContract)`	Updates a subscription contract with new values.