Rsl.Lotteries

UpdateSubscription

Change a subscription plan

The following routes are available for this service:
PATCH	/subscriptions/{SubscriptionId}/changeplan

**UpdateSubscription** Parameters:
Name	Parameter	Data Type	Required	Description
SubscriptionId	path	string	Yes	Subscription Id to be updated
GameType	query	string	No	Gamtype
Plan	query	string	No	The new subscription plan or null if unchanged.
PaymentMethod	query	PaymentMethodType?	No	The new payment method or leave blank to keep the payment method. Can also be left blank if specifying a nonce/token instead.
PaymentMethodNonce	query	string	No	The new payment method nonce if changing payment method from a nonce.
PaymentMethodToken	query	string	No	The new payment method token if changing payment method from a token.
CardholderName	query	string	No	Cardholder name if specifying a credit card nonce
FundingSourceId	query	string	No	The new funding source id to use or null if unchanged.
StartFromArtUnionId	query	string	No	The art union to start from. Either provide starting art union or starting date
StartDate	query	DateTime?	No	New date from which the lottery should start. Either provide starting art union or starting date
EndDate	query	DateTime?	No	Date when the subscription should end
NoEndDate	query	bool?	No	True, to set the subscription to never expire
RequestReference	query	RequestReference	No	Attribution values associated to the request if any

**PaymentMethodType** Enum:
Cash
Cheque
MoneyOrder
CreditCard
PayPal
DirectDebit
Wallet
GooglePay
ApplePay

**RequestReference** Parameters:
Name	Parameter	Data Type	Required
CampaignId	form	string	No
RetailChannelId	form	string	Yes
ReferenceId	form	string	No

**Subscription** Parameters:
Name	Parameter	Data Type	Required
SubscriptionId	form	string	No
CustomerId	form	string	No
StartFromArtUnionId	form	string	No
PaymentMethod	form	PaymentMethodType	No
FundingSourceId	form	string	No
Plan	form	string	No
GameType	form	string	No
StartDate	form	DateTime	No
EndDate	form	DateTime?	No
SubscriptionSuspension	form	IEnumerable<SubscriptionSuspension>	No
Status	form	SubscriptionStatus	No
SubscribedDate	form	DateTime	No
CreditCard	form	CreditCard	No
GooglePayAccount	form	GooglePayAccount	No
ApplePayAccount	form	ApplePayAccount	No
PayPal	form	PayPalAccount	No
ReasonCode	form	string	No

**SubscriptionSuspension** Parameters:
Name	Parameter	Data Type	Required
SubscriptionId	form	string	No
StartDate	form	DateTime	No
EndDate	form	DateTime?	No
ReasonCode	form	string	No

**SubscriptionStatus** Enum:
Pending
Active
Suspended
Cancelled

**CreditCard** Parameters:
Name	Parameter	Data Type	Required	Description
CreditCardId	form	string	No
CardToken	form	string	No
Token	form	string	No
CardholderName	form	string	No
CardType	form	CreditCardType	No
UniqueNumberIdentifier	form	string	No
ExpirationMonth	form	string	No
ExpirationYear	form	string	No
Bin	form	string	No
LastFour	form	string	No	The last 4 digits of the credit card number
IsDefault	form	bool	No
Disabled	form	bool	No
LastModified	form	DateTime	No

**CreditCardType** Enum:
Unknown
AmericanExpress
CarteBlanche
ChinaUnionPay
DinersClub
Discover
JCB
Laser
Maestro
MasterCard
Solo
Switch
Visa

**GooglePayAccount** Parameters:
Name	Parameter	Data Type	Required	Description
UniqueCardId	form	string	No
SourceCardType	form	string	No
CustomerId	form	string	No
ExpirationMonth	form	string	No
ExpirationYear	form	string	No
Bin	form	string	No	The first 6 digits of the credit card, known as the Bank Identification Number.
GoogleTransactionId	form	string	No	The last 4 digits of the credit card number
SourceCardLast4	form	string	No
CardholderName	form	string	No
CreatedAt	form	DateTime	No	The date/time the payment method was created
Token	form	string	No	The payment method token
Disabled	form	bool	No
IsDefault	form	bool	No

**ApplePayAccount** Parameters:
Name	Parameter	Data Type	Required	Description
UniqueCardId	form	string	No
CardType	form	string	No
CustomerId	form	string	No
ExpirationMonth	form	string	No
ExpirationYear	form	string	No
Bin	form	string	No	The first 6 digits of the credit card, known as the Bank Identification Number.
LastFour	form	string	No	The last 4 digits of the credit card number
CardholderName	form	string	No
CreatedAt	form	DateTime	No	The date/time the payment method was created
Token	form	string	No
IsDefault	form	bool	No
Disabled	form	bool	No

**PayPalAccount** Parameters:
Name	Parameter	Data Type	Required	Description
PayPalAccountId	form	string	No	The unique identifier of the PayPal acount in Dynamics
Token	form	string	No	The payment method token
Email	form	string	No	The email address belonging to the Paypal account
BillingAgreementId	form	string	No	The unique identifier of the vaulted payment flow agreement between the customer's PayPal account and RSL PayPal business account
CreatedAt	form	DateTime	No	The date/time the payment method was created
IsDefault	form	bool	No
Disabled	form	bool	No
IsNewCustomerPayPalFee	form	bool?	No	Whether to apply a different fee for customer coming from PayPal

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PATCH /subscriptions/{SubscriptionId}/changeplan HTTP/1.1 
Host: azs-stg-lotteries-web.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	subscriptionId: String,
	gameType: String,
	plan: String,
	paymentMethod: Cash,
	paymentMethodNonce: String,
	paymentMethodToken: String,
	cardholderName: String,
	fundingSourceId: String,
	startFromArtUnionId: String,
	startDate: 0001-01-01,
	endDate: 0001-01-01,
	noEndDate: False,
	requestReference: 
	{
		campaignId: String,
		retailChannelId: String,
		referenceId: String
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	subscriptionId: String,
	customerId: String,
	startFromArtUnionId: String,
	paymentMethod: Cash,
	fundingSourceId: String,
	plan: String,
	gameType: String,
	startDate: 0001-01-01,
	endDate: 0001-01-01,
	status: Pending,
	subscribedDate: 0001-01-01,
	creditCard: 
	{
		creditCardId: String,
		cardToken: String,
		token: String,
		cardholderName: String,
		cardType: Unknown,
		uniqueNumberIdentifier: String,
		expirationMonth: String,
		expirationYear: String,
		bin: String,
		lastFour: String,
		isDefault: False,
		disabled: False,
		lastModified: 0001-01-01
	},
	googlePayAccount: 
	{
		uniqueCardId: String,
		sourceCardType: String,
		customerId: String,
		expirationMonth: String,
		expirationYear: String,
		bin: String,
		googleTransactionId: String,
		sourceCardLast4: String,
		cardholderName: String,
		createdAt: 0001-01-01,
		token: String,
		disabled: False,
		isDefault: False
	},
	applePayAccount: 
	{
		uniqueCardId: String,
		cardType: String,
		customerId: String,
		expirationMonth: String,
		expirationYear: String,
		bin: String,
		lastFour: String,
		cardholderName: String,
		createdAt: 0001-01-01,
		token: String,
		isDefault: False,
		disabled: False
	},
	payPal: 
	{
		payPalAccountId: String,
		token: String,
		email: String,
		billingAgreementId: String,
		createdAt: 0001-01-01,
		isDefault: False,
		disabled: False,
		isNewCustomerPayPalFee: False
	},
	reasonCode: String
}