Rsl.Lotteries

CreateCustomerSubscription

Create a subscription for the customer

The following routes are available for this service:
POST	/subscriptions

**CreateCustomerSubscription** Parameters:
Name	Parameter	Data Type	Required	Description
CustomerId	body	string	Yes	Customer for whom subscription to be created
StartFromArtUnionId	body	string	No	ArtUnion / Draw from when Subscription would start. Optional
Plan	body	string	Yes	Subscription plan
GameType	body	string	No	Gamtype for of subscription plan.
PaymentMethodNonce	body	string	No	Payment method nonce. Provide either nonce, token or funding source id.
PaymentMethodToken	body	string	No	Payment method token. Provide either nonce, token or funding source id.
CardholderName	body	string	No	Cardholder name if specifying a credit card nonce
PaymentMethod	body	PaymentMethodType?	No	Payment method type. Required unless using a nonce or token.
FundingSourceId	body	string	No	Funding source identifier. Provide either nonce, token or funding source id.
StartDate	body	DateTime?	No	Date when subscription starts. Defaults to either start art union opening date or today.
EndDate	body	DateTime?	No	Date when subscription ends
SubscribedDate	body	DateTime?	No	Date when subscription was applied for. Defaults to now.
RequestReference	body	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.

POST /subscriptions HTTP/1.1 
Host: azs-stg-lotteries-web.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	customerId: String,
	startFromArtUnionId: String,
	plan: String,
	gameType: String,
	paymentMethodNonce: String,
	paymentMethodToken: String,
	cardholderName: String,
	paymentMethod: Cash,
	fundingSourceId: String,
	startDate: 0001-01-01,
	endDate: 0001-01-01,
	subscribedDate: 0001-01-01,
	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
}