<back to all web services
Customer
The following routes are available for this service:All Verbs | /Customer | | |
---|
All Verbs | /Customer/{Id} | | |
---|
Customer Parameters:Name | Parameter | Data Type | Required | Description |
---|
Id | path | int | No | |
Email | query | string | No | |
DisplayName | query | string | No | |
FirstName | query | string | No | |
LastName | query | string | No | |
Company | query | string | No | |
PhoneNumber | query | string | No | |
AddressLine1 | query | string | No | |
AddressLine2 | query | string | No | |
AddressCity | query | string | No | |
AddressZip | query | string | No | |
AddressState | query | string | No | |
AddressCountry | query | string | No | |
StripeCustomerId | query | string | No | |
StripeCouponId | query | string | No | |
Plan | query | string | No | |
CreatedDate | query | DateTime | No | |
IsReferrer | query | bool | No | |
Orders | query | List<Order> | No | |
Subscriptions | query | List<Subscription> | No | |
Order Parameters:Name | Parameter | Data Type | Required | Description |
---|
Id | form | int | No | |
CustomerId | form | int | No | |
ProductName | form | string | No | |
FirstName | form | string | No | |
LastName | form | string | No | |
Email | form | string | No | |
Company | form | string | No | |
PhoneNumber | form | string | No | |
AddressLine1 | form | string | No | |
AddressLine2 | form | string | No | |
AddressCity | form | string | No | |
AddressZip | form | string | No | |
AddressState | form | string | No | |
AddressCountry | form | string | No | |
AgreeTerms | form | bool | No | |
Notes | form | string | No | |
Last4 | form | string | No | |
SubTotal | form | int | No | |
CouponId | form | string | No | |
Discount | form | int | No | |
Tax | form | int | No | |
Total | form | int | No | |
ItemQuantity | form | int | No | |
AuthorizedQuantity | form | int? | No | |
SubscriptionId | form | int? | No | |
LicenseRef | form | string | No | |
PaymentId | form | int? | No | |
EmailId | form | int? | No | |
Paid | form | bool | No | |
CreatedDate | form | DateTime | No | |
ModifiedDate | form | DateTime | No | |
ModifiedBy | form | string | No | |
CancelledDate | form | DateTime? | No | |
CancelledReason | form | string | No | |
IpAddress | form | string | No | |
OrderDetails | form | List<OrderDetail> | No | |
OrderDetail Parameters:Name | Parameter | Data Type | Required | Description |
---|
Id | form | int | No | |
OrderId | form | int | No | |
SkuId | form | int | No | |
SkuType | form | SkuType | No | |
Price | form | int | No | |
Description | form | string | No | |
Quantity | form | int | No | |
Total | form | int | No | |
SkuType Enum:Product | |
PerDev | |
PerCore | |
Site | |
Support | |
Training | |
Register | |
Payment | |
Subscription Parameters:Name | Parameter | Data Type | Required | Description |
---|
Id | form | int | No | |
CustomerId | form | int | No | |
Email | form | string | No | |
SkuId | form | int | No | |
SkuName | form | string | No | |
SkuType | form | SkuType | No | |
Code | form | string | No | |
Quantity | form | int | No | |
SupportQuantity | form | int | No | |
Total | form | int | No | |
IsPlan | form | bool | No | |
IsRenewal | form | bool | No | |
SubscriptionDurationDays | form | int | No | |
RenewalDate | form | DateTime? | No | |
LicenseRef | form | string | No | |
LicenseName | form | string | No | |
LicenseAddress | form | string | No | |
LicenseType | form | LicenseType | No | |
ExpiryDate | form | DateTime | No | |
LicenseKey | form | LicenseKey | No | |
LicenseKeyText | form | string | No | |
CreatedDate | form | DateTime | No | |
ModifiedDate | form | DateTime | No | |
CancelledDate | form | DateTime? | No | |
StripeSubscriptionId | form | string | No | |
EmailId | form | int? | No | |
EmailRenewalId | form | int? | No | |
EmailExpiredId | form | int? | No | |
RenewalSubscriptionId | form | int? | No | |
ExternalRef | form | string | No | |
Notes | form | string | No | |
Error | form | string | No | |
LicenseType Enum:Free | |
FreeIndividual | |
FreeOpenSource | |
Indie | |
Business | |
Enterprise | |
TextIndie | |
TextBusiness | |
OrmLiteIndie | |
OrmLiteBusiness | |
RedisIndie | |
RedisBusiness | |
AwsIndie | |
AwsBusiness | |
Trial | |
Site | |
TextSite | |
RedisSite | |
OrmLiteSite | |
LicenseKey Parameters:Name | Parameter | Data Type | Required | Description |
---|
Ref | form | string | No | |
Name | form | string | No | |
Type | form | LicenseType | No | |
Meta | form | long | No | |
Hash | form | string | No | |
Halg | form | string | No | |
Expiry | form | DateTime | No | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
HTTP + XML
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
POST /Customer HTTP/1.1
Host: account.servicestack.net
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<Customer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
<AddressCity>String</AddressCity>
<AddressCountry>String</AddressCountry>
<AddressLine1>String</AddressLine1>
<AddressLine2>String</AddressLine2>
<AddressState>String</AddressState>
<AddressZip>String</AddressZip>
<Company>String</Company>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<DisplayName>String</DisplayName>
<Email>String</Email>
<FirstName>String</FirstName>
<Id>0</Id>
<IsReferrer>false</IsReferrer>
<LastName>String</LastName>
<Orders>
<Order>
<AddressCity>String</AddressCity>
<AddressCountry>String</AddressCountry>
<AddressLine1>String</AddressLine1>
<AddressLine2>String</AddressLine2>
<AddressState>String</AddressState>
<AddressZip>String</AddressZip>
<AgreeTerms>false</AgreeTerms>
<AuthorizedQuantity>0</AuthorizedQuantity>
<CancelledDate>0001-01-01T00:00:00</CancelledDate>
<CancelledReason>String</CancelledReason>
<Company>String</Company>
<CouponId>String</CouponId>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<CustomerId>0</CustomerId>
<Discount>0</Discount>
<Email>String</Email>
<EmailId>0</EmailId>
<FirstName>String</FirstName>
<Id>0</Id>
<IpAddress>String</IpAddress>
<ItemQuantity>0</ItemQuantity>
<Last4>String</Last4>
<LastName>String</LastName>
<LicenseRef>String</LicenseRef>
<ModifiedBy>String</ModifiedBy>
<ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
<Notes>String</Notes>
<OrderDetails>
<OrderDetail>
<Description>String</Description>
<Id>0</Id>
<OrderId>0</OrderId>
<Price>0</Price>
<Quantity>0</Quantity>
<SkuId>0</SkuId>
<SkuType>Product</SkuType>
<Total>0</Total>
</OrderDetail>
</OrderDetails>
<Paid>false</Paid>
<PaymentId>0</PaymentId>
<PhoneNumber>String</PhoneNumber>
<ProductName>String</ProductName>
<SubTotal>0</SubTotal>
<SubscriptionId>0</SubscriptionId>
<Tax>0</Tax>
<Total>0</Total>
</Order>
</Orders>
<PhoneNumber>String</PhoneNumber>
<Plan>String</Plan>
<StripeCouponId>String</StripeCouponId>
<StripeCustomerId>String</StripeCustomerId>
<Subscriptions>
<Subscription>
<CancelledDate>0001-01-01T00:00:00</CancelledDate>
<Code>String</Code>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<CustomerId>0</CustomerId>
<Email>String</Email>
<EmailExpiredId>0</EmailExpiredId>
<EmailId>0</EmailId>
<EmailRenewalId>0</EmailRenewalId>
<Error>String</Error>
<ExpiryDate>0001-01-01T00:00:00</ExpiryDate>
<ExternalRef>String</ExternalRef>
<Id>0</Id>
<IsPlan>false</IsPlan>
<IsRenewal>false</IsRenewal>
<LicenseAddress>String</LicenseAddress>
<LicenseKey xmlns:d4p1="http://schemas.datacontract.org/2004/07/ServiceStack">
<d4p1:Expiry>0001-01-01T00:00:00</d4p1:Expiry>
<d4p1:Halg>String</d4p1:Halg>
<d4p1:Hash>String</d4p1:Hash>
<d4p1:Meta>0</d4p1:Meta>
<d4p1:Name>String</d4p1:Name>
<d4p1:Ref>String</d4p1:Ref>
<d4p1:Type>Free</d4p1:Type>
</LicenseKey>
<LicenseKeyText>String</LicenseKeyText>
<LicenseName>String</LicenseName>
<LicenseRef>String</LicenseRef>
<LicenseType>Free</LicenseType>
<ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
<Notes>String</Notes>
<Quantity>0</Quantity>
<RenewalDate>0001-01-01T00:00:00</RenewalDate>
<RenewalSubscriptionId>0</RenewalSubscriptionId>
<SkuId>0</SkuId>
<SkuName>String</SkuName>
<SkuType>Product</SkuType>
<StripeSubscriptionId>String</StripeSubscriptionId>
<SubscriptionDurationDays>0</SubscriptionDurationDays>
<SupportQuantity>0</SupportQuantity>
<Total>0</Total>
</Subscription>
</Subscriptions>
</Customer>