ServiceStack Home (Live)

<back to all web services

Customer

The following routes are available for this service:
All Verbs/Customer
All Verbs/Customer/{Id}
import 'package:servicestack/servicestack.dart';

enum SkuType
{
    Product,
    PerDev,
    PerCore,
    Site,
    Support,
    Training,
    Register,
    Payment,
}

class OrderDetail implements IConvertible
{
    int? id;
    int? orderId;
    int? skuId;
    SkuType? skuType;
    int? price;
    String? description;
    int? quantity;
    int? total;

    OrderDetail({this.id,this.orderId,this.skuId,this.skuType,this.price,this.description,this.quantity,this.total});
    OrderDetail.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        orderId = json['orderId'];
        skuId = json['skuId'];
        skuType = JsonConverters.fromJson(json['skuType'],'SkuType',context!);
        price = json['price'];
        description = json['description'];
        quantity = json['quantity'];
        total = json['total'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'orderId': orderId,
        'skuId': skuId,
        'skuType': JsonConverters.toJson(skuType,'SkuType',context!),
        'price': price,
        'description': description,
        'quantity': quantity,
        'total': total
    };

    getTypeName() => "OrderDetail";
    TypeContext? context = _ctx;
}

class Order implements IAddress, IConvertible
{
    int? id;
    int? customerId;
    String? productName;
    String? firstName;
    String? lastName;
    String? email;
    String? company;
    String? phoneNumber;
    String? addressLine1;
    String? addressLine2;
    String? addressCity;
    String? addressZip;
    String? addressState;
    String? addressCountry;
    bool? agreeTerms;
    String? notes;
    String? last4;
    int? subTotal;
    String? couponId;
    int? discount;
    int? tax;
    int? total;
    int? itemQuantity;
    int? authorizedQuantity;
    int? subscriptionId;
    String? licenseRef;
    int? paymentId;
    int? emailId;
    bool? paid;
    DateTime? createdDate;
    DateTime? modifiedDate;
    String? modifiedBy;
    DateTime? cancelledDate;
    String? cancelledReason;
    String? ipAddress;
    List<OrderDetail>? orderDetails;

    Order({this.id,this.customerId,this.productName,this.firstName,this.lastName,this.email,this.company,this.phoneNumber,this.addressLine1,this.addressLine2,this.addressCity,this.addressZip,this.addressState,this.addressCountry,this.agreeTerms,this.notes,this.last4,this.subTotal,this.couponId,this.discount,this.tax,this.total,this.itemQuantity,this.authorizedQuantity,this.subscriptionId,this.licenseRef,this.paymentId,this.emailId,this.paid,this.createdDate,this.modifiedDate,this.modifiedBy,this.cancelledDate,this.cancelledReason,this.ipAddress,this.orderDetails});
    Order.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        customerId = json['customerId'];
        productName = json['productName'];
        firstName = json['firstName'];
        lastName = json['lastName'];
        email = json['email'];
        company = json['company'];
        phoneNumber = json['phoneNumber'];
        addressLine1 = json['addressLine1'];
        addressLine2 = json['addressLine2'];
        addressCity = json['addressCity'];
        addressZip = json['addressZip'];
        addressState = json['addressState'];
        addressCountry = json['addressCountry'];
        agreeTerms = json['agreeTerms'];
        notes = json['notes'];
        last4 = json['last4'];
        subTotal = json['subTotal'];
        couponId = json['couponId'];
        discount = json['discount'];
        tax = json['tax'];
        total = json['total'];
        itemQuantity = json['itemQuantity'];
        authorizedQuantity = json['authorizedQuantity'];
        subscriptionId = json['subscriptionId'];
        licenseRef = json['licenseRef'];
        paymentId = json['paymentId'];
        emailId = json['emailId'];
        paid = json['paid'];
        createdDate = JsonConverters.fromJson(json['createdDate'],'DateTime',context!);
        modifiedDate = JsonConverters.fromJson(json['modifiedDate'],'DateTime',context!);
        modifiedBy = json['modifiedBy'];
        cancelledDate = JsonConverters.fromJson(json['cancelledDate'],'DateTime',context!);
        cancelledReason = json['cancelledReason'];
        ipAddress = json['ipAddress'];
        orderDetails = JsonConverters.fromJson(json['orderDetails'],'List<OrderDetail>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'customerId': customerId,
        'productName': productName,
        'firstName': firstName,
        'lastName': lastName,
        'email': email,
        'company': company,
        'phoneNumber': phoneNumber,
        'addressLine1': addressLine1,
        'addressLine2': addressLine2,
        'addressCity': addressCity,
        'addressZip': addressZip,
        'addressState': addressState,
        'addressCountry': addressCountry,
        'agreeTerms': agreeTerms,
        'notes': notes,
        'last4': last4,
        'subTotal': subTotal,
        'couponId': couponId,
        'discount': discount,
        'tax': tax,
        'total': total,
        'itemQuantity': itemQuantity,
        'authorizedQuantity': authorizedQuantity,
        'subscriptionId': subscriptionId,
        'licenseRef': licenseRef,
        'paymentId': paymentId,
        'emailId': emailId,
        'paid': paid,
        'createdDate': JsonConverters.toJson(createdDate,'DateTime',context!),
        'modifiedDate': JsonConverters.toJson(modifiedDate,'DateTime',context!),
        'modifiedBy': modifiedBy,
        'cancelledDate': JsonConverters.toJson(cancelledDate,'DateTime',context!),
        'cancelledReason': cancelledReason,
        'ipAddress': ipAddress,
        'orderDetails': JsonConverters.toJson(orderDetails,'List<OrderDetail>',context!)
    };

    getTypeName() => "Order";
    TypeContext? context = _ctx;
}

enum LicenseType
{
    Free,
    FreeIndividual,
    FreeOpenSource,
    Indie,
    Business,
    Enterprise,
    TextIndie,
    TextBusiness,
    OrmLiteIndie,
    OrmLiteBusiness,
    RedisIndie,
    RedisBusiness,
    AwsIndie,
    AwsBusiness,
    Trial,
    Site,
    TextSite,
    RedisSite,
    OrmLiteSite,
}

class LicenseKey implements IConvertible
{
    String? ref;
    String? name;
    LicenseType? type;
    int? meta;
    String? hash;
    String? halg;
    DateTime? expiry;

    LicenseKey({this.ref,this.name,this.type,this.meta,this.hash,this.halg,this.expiry});
    LicenseKey.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ref = json['ref'];
        name = json['name'];
        type = JsonConverters.fromJson(json['type'],'LicenseType',context!);
        meta = json['meta'];
        hash = json['hash'];
        halg = json['halg'];
        expiry = JsonConverters.fromJson(json['expiry'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ref': ref,
        'name': name,
        'type': JsonConverters.toJson(type,'LicenseType',context!),
        'meta': meta,
        'hash': hash,
        'halg': halg,
        'expiry': JsonConverters.toJson(expiry,'DateTime',context!)
    };

    getTypeName() => "LicenseKey";
    TypeContext? context = _ctx;
}

class Subscription implements IConvertible
{
    int? id;
    int? customerId;
    String? email;
    int? skuId;
    String? skuName;
    SkuType? skuType;
    String? code;
    int? quantity;
    int? supportQuantity;
    int? total;
    bool? isPlan;
    bool? isRenewal;
    int? subscriptionDurationDays;
    DateTime? renewalDate;
    String? licenseRef;
    String? licenseName;
    String? licenseAddress;
    LicenseType? licenseType;
    DateTime? expiryDate;
    LicenseKey? licenseKey;
    String? licenseKeyText;
    DateTime? createdDate;
    DateTime? modifiedDate;
    DateTime? cancelledDate;
    String? stripeSubscriptionId;
    int? emailId;
    int? emailRenewalId;
    int? emailExpiredId;
    int? renewalSubscriptionId;
    String? externalRef;
    String? notes;
    String? error;

    Subscription({this.id,this.customerId,this.email,this.skuId,this.skuName,this.skuType,this.code,this.quantity,this.supportQuantity,this.total,this.isPlan,this.isRenewal,this.subscriptionDurationDays,this.renewalDate,this.licenseRef,this.licenseName,this.licenseAddress,this.licenseType,this.expiryDate,this.licenseKey,this.licenseKeyText,this.createdDate,this.modifiedDate,this.cancelledDate,this.stripeSubscriptionId,this.emailId,this.emailRenewalId,this.emailExpiredId,this.renewalSubscriptionId,this.externalRef,this.notes,this.error});
    Subscription.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        customerId = json['customerId'];
        email = json['email'];
        skuId = json['skuId'];
        skuName = json['skuName'];
        skuType = JsonConverters.fromJson(json['skuType'],'SkuType',context!);
        code = json['code'];
        quantity = json['quantity'];
        supportQuantity = json['supportQuantity'];
        total = json['total'];
        isPlan = json['isPlan'];
        isRenewal = json['isRenewal'];
        subscriptionDurationDays = json['subscriptionDurationDays'];
        renewalDate = JsonConverters.fromJson(json['renewalDate'],'DateTime',context!);
        licenseRef = json['licenseRef'];
        licenseName = json['licenseName'];
        licenseAddress = json['licenseAddress'];
        licenseType = JsonConverters.fromJson(json['licenseType'],'LicenseType',context!);
        expiryDate = JsonConverters.fromJson(json['expiryDate'],'DateTime',context!);
        licenseKey = JsonConverters.fromJson(json['licenseKey'],'LicenseKey',context!);
        licenseKeyText = json['licenseKeyText'];
        createdDate = JsonConverters.fromJson(json['createdDate'],'DateTime',context!);
        modifiedDate = JsonConverters.fromJson(json['modifiedDate'],'DateTime',context!);
        cancelledDate = JsonConverters.fromJson(json['cancelledDate'],'DateTime',context!);
        stripeSubscriptionId = json['stripeSubscriptionId'];
        emailId = json['emailId'];
        emailRenewalId = json['emailRenewalId'];
        emailExpiredId = json['emailExpiredId'];
        renewalSubscriptionId = json['renewalSubscriptionId'];
        externalRef = json['externalRef'];
        notes = json['notes'];
        error = json['error'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'customerId': customerId,
        'email': email,
        'skuId': skuId,
        'skuName': skuName,
        'skuType': JsonConverters.toJson(skuType,'SkuType',context!),
        'code': code,
        'quantity': quantity,
        'supportQuantity': supportQuantity,
        'total': total,
        'isPlan': isPlan,
        'isRenewal': isRenewal,
        'subscriptionDurationDays': subscriptionDurationDays,
        'renewalDate': JsonConverters.toJson(renewalDate,'DateTime',context!),
        'licenseRef': licenseRef,
        'licenseName': licenseName,
        'licenseAddress': licenseAddress,
        'licenseType': JsonConverters.toJson(licenseType,'LicenseType',context!),
        'expiryDate': JsonConverters.toJson(expiryDate,'DateTime',context!),
        'licenseKey': JsonConverters.toJson(licenseKey,'LicenseKey',context!),
        'licenseKeyText': licenseKeyText,
        'createdDate': JsonConverters.toJson(createdDate,'DateTime',context!),
        'modifiedDate': JsonConverters.toJson(modifiedDate,'DateTime',context!),
        'cancelledDate': JsonConverters.toJson(cancelledDate,'DateTime',context!),
        'stripeSubscriptionId': stripeSubscriptionId,
        'emailId': emailId,
        'emailRenewalId': emailRenewalId,
        'emailExpiredId': emailExpiredId,
        'renewalSubscriptionId': renewalSubscriptionId,
        'externalRef': externalRef,
        'notes': notes,
        'error': error
    };

    getTypeName() => "Subscription";
    TypeContext? context = _ctx;
}

class Customer implements IAddress, IConvertible
{
    int? id;
    String? email;
    String? displayName;
    String? firstName;
    String? lastName;
    String? company;
    String? phoneNumber;
    String? addressLine1;
    String? addressLine2;
    String? addressCity;
    String? addressZip;
    String? addressState;
    String? addressCountry;
    String? stripeCustomerId;
    String? stripeCouponId;
    String? plan;
    DateTime? createdDate;
    bool? isReferrer;
    List<Order>? orders;
    List<Subscription>? subscriptions;

    Customer({this.id,this.email,this.displayName,this.firstName,this.lastName,this.company,this.phoneNumber,this.addressLine1,this.addressLine2,this.addressCity,this.addressZip,this.addressState,this.addressCountry,this.stripeCustomerId,this.stripeCouponId,this.plan,this.createdDate,this.isReferrer,this.orders,this.subscriptions});
    Customer.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        email = json['email'];
        displayName = json['displayName'];
        firstName = json['firstName'];
        lastName = json['lastName'];
        company = json['company'];
        phoneNumber = json['phoneNumber'];
        addressLine1 = json['addressLine1'];
        addressLine2 = json['addressLine2'];
        addressCity = json['addressCity'];
        addressZip = json['addressZip'];
        addressState = json['addressState'];
        addressCountry = json['addressCountry'];
        stripeCustomerId = json['stripeCustomerId'];
        stripeCouponId = json['stripeCouponId'];
        plan = json['plan'];
        createdDate = JsonConverters.fromJson(json['createdDate'],'DateTime',context!);
        isReferrer = json['isReferrer'];
        orders = JsonConverters.fromJson(json['orders'],'List<Order>',context!);
        subscriptions = JsonConverters.fromJson(json['subscriptions'],'List<Subscription>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'email': email,
        'displayName': displayName,
        'firstName': firstName,
        'lastName': lastName,
        'company': company,
        'phoneNumber': phoneNumber,
        'addressLine1': addressLine1,
        'addressLine2': addressLine2,
        'addressCity': addressCity,
        'addressZip': addressZip,
        'addressState': addressState,
        'addressCountry': addressCountry,
        'stripeCustomerId': stripeCustomerId,
        'stripeCouponId': stripeCouponId,
        'plan': plan,
        'createdDate': JsonConverters.toJson(createdDate,'DateTime',context!),
        'isReferrer': isReferrer,
        'orders': JsonConverters.toJson(orders,'List<Order>',context!),
        'subscriptions': JsonConverters.toJson(subscriptions,'List<Subscription>',context!)
    };

    getTypeName() => "Customer";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'account.servicestack.net', types: <String, TypeInfo> {
    'SkuType': TypeInfo(TypeOf.Enum, enumValues:SkuType.values),
    'OrderDetail': TypeInfo(TypeOf.Class, create:() => OrderDetail()),
    'Order': TypeInfo(TypeOf.Class, create:() => Order()),
    'List<OrderDetail>': TypeInfo(TypeOf.Class, create:() => <OrderDetail>[]),
    'LicenseType': TypeInfo(TypeOf.Enum, enumValues:LicenseType.values),
    'LicenseKey': TypeInfo(TypeOf.Class, create:() => LicenseKey()),
    'Subscription': TypeInfo(TypeOf.Class, create:() => Subscription()),
    'Customer': TypeInfo(TypeOf.Class, create:() => Customer()),
    'List<Order>': TypeInfo(TypeOf.Class, create:() => <Order>[]),
    'List<Subscription>': TypeInfo(TypeOf.Class, create:() => <Subscription>[]),
});

Dart Customer DTOs

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 /Customer HTTP/1.1 
Host: account.servicestack.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	email: String,
	displayName: String,
	firstName: String,
	lastName: String,
	company: String,
	phoneNumber: String,
	addressLine1: String,
	addressLine2: String,
	addressCity: String,
	addressZip: String,
	addressState: String,
	addressCountry: String,
	stripeCustomerId: String,
	stripeCouponId: String,
	plan: String,
	createdDate: 0001-01-01,
	isReferrer: False,
	orders: 
	[
		{
			id: 0,
			customerId: 0,
			productName: String,
			firstName: String,
			lastName: String,
			email: String,
			company: String,
			phoneNumber: String,
			addressLine1: String,
			addressLine2: String,
			addressCity: String,
			addressZip: String,
			addressState: String,
			addressCountry: String,
			agreeTerms: False,
			notes: String,
			last4: String,
			subTotal: 0,
			couponId: String,
			discount: 0,
			tax: 0,
			total: 0,
			itemQuantity: 0,
			authorizedQuantity: 0,
			subscriptionId: 0,
			licenseRef: String,
			paymentId: 0,
			emailId: 0,
			paid: False,
			createdDate: 0001-01-01,
			modifiedDate: 0001-01-01,
			modifiedBy: String,
			cancelledDate: 0001-01-01,
			cancelledReason: String,
			ipAddress: String,
			orderDetails: 
			[
				{
					id: 0,
					orderId: 0,
					skuId: 0,
					skuType: Product,
					price: 0,
					description: String,
					quantity: 0,
					total: 0
				}
			]
		}
	],
	subscriptions: 
	[
		{
			id: 0,
			customerId: 0,
			email: String,
			skuId: 0,
			skuName: String,
			skuType: Product,
			code: String,
			quantity: 0,
			supportQuantity: 0,
			total: 0,
			isPlan: False,
			isRenewal: False,
			subscriptionDurationDays: 0,
			renewalDate: 0001-01-01,
			licenseRef: String,
			licenseName: String,
			licenseAddress: String,
			licenseType: Free,
			expiryDate: 0001-01-01,
			licenseKey: 
			{
				ref: String,
				name: String,
				type: Free,
				meta: 0,
				hash: String,
				halg: String,
				expiry: 0001-01-01
			},
			licenseKeyText: String,
			createdDate: 0001-01-01,
			modifiedDate: 0001-01-01,
			cancelledDate: 0001-01-01,
			stripeSubscriptionId: String,
			emailId: 0,
			emailRenewalId: 0,
			emailExpiredId: 0,
			renewalSubscriptionId: 0,
			externalRef: String,
			notes: String,
			error: String
		}
	]
}