Subscription endpoint

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

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

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

Table 1. Subscription API methods
Method	Method signature	Purpose
addIpRange()	`SubscriptionIpRange addIpRange( string usn, IpRange ipRange)`	Allocates an IP range reservation to a subscription.
addIpRangeReservation()	`SubscriptionIpRange addIpRangeReservation( string usn, string reservationId)`	Adds an IP range reservation to a subscription.
applyFeature()	`subscriptionFeatureId applyFeature( string usn, int featureId, date startDate, date endDate)`	Applies a feature to a subscription for the specified length of time.
applyFeatureToConnections()	`void applyFeatureToConnections( string usn, int featureId)`	Applies a feature to any active connections for a USN.
cancel()	`void cancel( string usn, date fromTimestamp)`	Cancels a subscription.
changeUsername()	`void changeUsername( string usn, string username)`	Changes the username of a subscription.
changePlan()	`void changePlan( string usn, PlanScheduleItem planScheduleItem)`	Changes the plan schedule for a subscription, that is, changes the plan that a subscription uses.
findSubscription()	`Subscription findSubscription( SearchCondition searchCondition)`	Searches by custom field value for a subscription and returns subscription information.
findSubscriptions()	`SubscriptionSearchResultList findSubscriptions( SearchCondition searchCondition, int limit, int offset)`	Searches by custom field for non-closed subscriptions and returns subscription information.
findUsername()	`string findUsername( int sid, string username)`	Returns the USN for a given username and service.
get()	`Subscription get(string usn)`	Searches by USN for a subscription and returns subscription information.
getActiveFeatures()	`SubscriptionFeatureList getActiveFeatures( string usn)`	Returns all active features on a subscription.
getActivityStatementBatch()	`ActivityBatchURL getActivityStatementBatch( string usn, long batchId)`	Returns a URL from which you can download unrated activity statements by batch number.
getActivityStatementRange()	`ActivityBatchURL getActivityStatementRange( string usn, dateTime startTimestamp, dateTime endTimestamp)`	Returns a URL from which you can download unrated activity statements by date range.
getAuthenticationCredentials()	`Credentials getAuthenticationCredentials( string usn)`	Retrieves a user password.
getConnectionHistory()	`ConnectionListType getConnectionHistory( string usn, ConnectionHistoryQuery connectionHistoryQuery, int limit, int offset)`	Returns the connection history of a subscription for a given date range.
getIpRanges()	`SubscriptionIpRanges getIpRanges( string usn)`	Returns all IP range reservations for a subscription.
getPlanChargeDescription()	`PlanChargeDescriptionType getPlanChargeDescription( string usn, int planScheduleItem)`	Returns information about the charge configuration for a subscription, according to the given plan schedule item.
getPlanScheduleItemsAt()	`PlanScheduleItems getPlanScheduleItemsAt( string usn, timestamp instant)`	Returns information about the plan that a subscription uses at a specified time.
getPlanSchedules()	`PlanSchedules getPlanSchedules( string usn)`	Returns information about all plans associated with a subscription throughout its lifecycle.
getPoolReservationLinks()	`PoolReservationLinks getPoolReservationLinks( string usn)`	Returns all active pool reservation links of a subscription.
getRatingPeriods()	`RatingPeriodListType getRatingPeriods(string usn)`	Returns information about a subscription's rating periods.
getRatingsForPeriod()	`ActivityBatchURL getRatingsForPeriod( int ratingPeriodId)`	Returns a URL from which you can download rated activity statements by rating period.
migrateSubscription()	`void migrateSubscription( string usn, string toAccountUsn)`	Migrates a subscription from one account to another nominated account.
removeIpRange()	`void removeIpRange( string usn, string ipRangeId)`	Removes an IP range reservation that was previously made with addIpRange().
removePoolReservationLink()	`PoolReservationLink removePoolReservationLink( string usn, string reservationLinkId)`	Removes a reservation link applied to the subscription.
resume()	`void resume( string usn, date fromTimestamp, string comment)`	Resumes a suspended subscription.
setClearPassword()	`void setClearPassword( string usn, Credential credential)`	Changes the password for an account or subscription.
setCostCentre()	`void setCostCentre( string usn, int costCentreId)`	Sets a cost centre for a subscription.
stopApplyingFeature()	`void stopApplyingFeature( string subscriptionFeatureId, date endDate)`	Changes the date on which Smile stops applying a feature.
suspend()	`void suspend( string usn, date fromTimestamp, string comment)`	Suspends a subscription.
update()	`Subscription update( string usn, Subscription subscription)`	Updates subscription information.