Required role: | Admin |
POST | /CreateCustomer |
---|
export enum SkuType
{
Product = 'Product',
PerDev = 'PerDev',
PerCore = 'PerCore',
Site = 'Site',
Support = 'Support',
Training = 'Training',
Register = 'Register',
Payment = 'Payment',
}
export class OrderDetail
{
public id: number;
public orderId: number;
public skuId: number;
public skuType: SkuType;
public price: number;
public description: string;
public quantity: number;
public total: number;
public constructor(init?: Partial<OrderDetail>) { (Object as any).assign(this, init); }
}
export class Order implements IAddress
{
public id: number;
public customerId: number;
public productName: string;
public firstName: string;
public lastName: string;
public email: string;
public company: string;
public phoneNumber: string;
public addressLine1: string;
public addressLine2: string;
public addressCity: string;
public addressZip: string;
public addressState: string;
public addressCountry: string;
public agreeTerms: boolean;
public notes: string;
public last4: string;
public subTotal: number;
public couponId: string;
public discount: number;
public tax: number;
public total: number;
public itemQuantity: number;
public authorizedQuantity?: number;
public subscriptionId?: number;
public licenseRef: string;
public paymentId?: number;
public emailId?: number;
public paid: boolean;
public createdDate: string;
public modifiedDate: string;
public modifiedBy: string;
public cancelledDate?: string;
public cancelledReason: string;
public ipAddress: string;
public orderDetails: OrderDetail[];
public constructor(init?: Partial<Order>) { (Object as any).assign(this, init); }
}
export enum LicenseType
{
Free = 'Free',
FreeIndividual = 'FreeIndividual',
FreeOpenSource = 'FreeOpenSource',
Indie = 'Indie',
Business = 'Business',
Enterprise = 'Enterprise',
TextIndie = 'TextIndie',
TextBusiness = 'TextBusiness',
OrmLiteIndie = 'OrmLiteIndie',
OrmLiteBusiness = 'OrmLiteBusiness',
RedisIndie = 'RedisIndie',
RedisBusiness = 'RedisBusiness',
AwsIndie = 'AwsIndie',
AwsBusiness = 'AwsBusiness',
Trial = 'Trial',
Site = 'Site',
TextSite = 'TextSite',
RedisSite = 'RedisSite',
OrmLiteSite = 'OrmLiteSite',
}
export class LicenseKey
{
public ref: string;
public name: string;
public type: LicenseType;
public meta: number;
public hash: string;
public halg: string;
public expiry: string;
public constructor(init?: Partial<LicenseKey>) { (Object as any).assign(this, init); }
}
export class Subscription
{
public id: number;
public customerId: number;
public email: string;
public skuId: number;
public skuName: string;
public skuType: SkuType;
public code: string;
public quantity: number;
public supportQuantity: number;
public total: number;
public isPlan: boolean;
public isRenewal: boolean;
public subscriptionDurationDays: number;
public renewalDate?: string;
public licenseRef: string;
public licenseName: string;
public licenseAddress: string;
public licenseType: LicenseType;
public expiryDate: string;
public licenseKey: LicenseKey;
public licenseKeyText: string;
public createdDate: string;
public modifiedDate: string;
public cancelledDate?: string;
public stripeSubscriptionId: string;
public emailId?: number;
public emailRenewalId?: number;
public emailExpiredId?: number;
public renewalSubscriptionId?: number;
public externalRef: string;
public notes: string;
public error: string;
public constructor(init?: Partial<Subscription>) { (Object as any).assign(this, init); }
}
export class Customer implements IAddress
{
public id: number;
public email: string;
public displayName: string;
public firstName: string;
public lastName: string;
public company: string;
public phoneNumber: string;
public addressLine1: string;
public addressLine2: string;
public addressCity: string;
public addressZip: string;
public addressState: string;
public addressCountry: string;
public stripeCustomerId: string;
public stripeCouponId: string;
public plan: string;
public createdDate: string;
public isReferrer: boolean;
public orders: Order[];
public subscriptions: Subscription[];
public constructor(init?: Partial<Customer>) { (Object as any).assign(this, init); }
}
// @ValidateRequest(Validator="IsAdmin")
export class CreateCustomer implements IPost
{
public firstName: string;
public lastName: string;
public email: string;
public password: string;
public company: string;
public phoneNumber: string;
public addressLine1: string;
public addressLine2: string;
public addressCity: string;
public addressZip: string;
public addressState: string;
public addressCountry: string;
public createdDate?: string;
public constructor(init?: Partial<CreateCustomer>) { (Object as any).assign(this, init); }
}
TypeScript CreateCustomer DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /CreateCustomer HTTP/1.1
Host: account.servicestack.net
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CreateCustomer 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>
<Email>String</Email>
<FirstName>String</FirstName>
<LastName>String</LastName>
<Password>String</Password>
<PhoneNumber>String</PhoneNumber>
</CreateCustomer>
HTTP/1.1 200 OK 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>