ServiceStack Home (Live)

<back to all web services

Customer

The following routes are available for this service:
All Verbs/Customer
All Verbs/Customer/{Id}
"use strict";
/** @typedef {'Product'|'PerDev'|'PerCore'|'Site'|'Support'|'Training'|'Register'|'Payment'} */
export var SkuType;
(function (SkuType) {
    SkuType["Product"] = "Product"
    SkuType["PerDev"] = "PerDev"
    SkuType["PerCore"] = "PerCore"
    SkuType["Site"] = "Site"
    SkuType["Support"] = "Support"
    SkuType["Training"] = "Training"
    SkuType["Register"] = "Register"
    SkuType["Payment"] = "Payment"
})(SkuType || (SkuType = {}));
export class OrderDetail {
    /** @param {{id?:number,orderId?:number,skuId?:number,skuType?:SkuType,price?:number,description?:string,quantity?:number,total?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {number} */
    orderId;
    /** @type {number} */
    skuId;
    /** @type {SkuType} */
    skuType;
    /** @type {number} */
    price;
    /** @type {string} */
    description;
    /** @type {number} */
    quantity;
    /** @type {number} */
    total;
}
export class Order {
    /** @param {{id?:number,customerId?:number,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?:boolean,notes?:string,last4?:string,subTotal?:number,couponId?:string,discount?:number,tax?:number,total?:number,itemQuantity?:number,authorizedQuantity?:number,subscriptionId?:number,licenseRef?:string,paymentId?:number,emailId?:number,paid?:boolean,createdDate?:string,modifiedDate?:string,modifiedBy?:string,cancelledDate?:string,cancelledReason?:string,ipAddress?:string,orderDetails?:OrderDetail[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {number} */
    customerId;
    /** @type {string} */
    productName;
    /** @type {string} */
    firstName;
    /** @type {string} */
    lastName;
    /** @type {string} */
    email;
    /** @type {string} */
    company;
    /** @type {string} */
    phoneNumber;
    /** @type {string} */
    addressLine1;
    /** @type {string} */
    addressLine2;
    /** @type {string} */
    addressCity;
    /** @type {string} */
    addressZip;
    /** @type {string} */
    addressState;
    /** @type {string} */
    addressCountry;
    /** @type {boolean} */
    agreeTerms;
    /** @type {string} */
    notes;
    /** @type {string} */
    last4;
    /** @type {number} */
    subTotal;
    /** @type {string} */
    couponId;
    /** @type {number} */
    discount;
    /** @type {number} */
    tax;
    /** @type {number} */
    total;
    /** @type {number} */
    itemQuantity;
    /** @type {?number} */
    authorizedQuantity;
    /** @type {?number} */
    subscriptionId;
    /** @type {string} */
    licenseRef;
    /** @type {?number} */
    paymentId;
    /** @type {?number} */
    emailId;
    /** @type {boolean} */
    paid;
    /** @type {string} */
    createdDate;
    /** @type {string} */
    modifiedDate;
    /** @type {string} */
    modifiedBy;
    /** @type {?string} */
    cancelledDate;
    /** @type {string} */
    cancelledReason;
    /** @type {string} */
    ipAddress;
    /** @type {OrderDetail[]} */
    orderDetails;
}
/** @typedef {'Free'|'FreeIndividual'|'FreeOpenSource'|'Indie'|'Business'|'Enterprise'|'TextIndie'|'TextBusiness'|'OrmLiteIndie'|'OrmLiteBusiness'|'RedisIndie'|'RedisBusiness'|'AwsIndie'|'AwsBusiness'|'Trial'|'Site'|'TextSite'|'RedisSite'|'OrmLiteSite'} */
export var LicenseType;
(function (LicenseType) {
    LicenseType["Free"] = "Free"
    LicenseType["FreeIndividual"] = "FreeIndividual"
    LicenseType["FreeOpenSource"] = "FreeOpenSource"
    LicenseType["Indie"] = "Indie"
    LicenseType["Business"] = "Business"
    LicenseType["Enterprise"] = "Enterprise"
    LicenseType["TextIndie"] = "TextIndie"
    LicenseType["TextBusiness"] = "TextBusiness"
    LicenseType["OrmLiteIndie"] = "OrmLiteIndie"
    LicenseType["OrmLiteBusiness"] = "OrmLiteBusiness"
    LicenseType["RedisIndie"] = "RedisIndie"
    LicenseType["RedisBusiness"] = "RedisBusiness"
    LicenseType["AwsIndie"] = "AwsIndie"
    LicenseType["AwsBusiness"] = "AwsBusiness"
    LicenseType["Trial"] = "Trial"
    LicenseType["Site"] = "Site"
    LicenseType["TextSite"] = "TextSite"
    LicenseType["RedisSite"] = "RedisSite"
    LicenseType["OrmLiteSite"] = "OrmLiteSite"
})(LicenseType || (LicenseType = {}));
export class LicenseKey {
    /** @param {{ref?:string,name?:string,type?:LicenseType,meta?:number,hash?:string,halg?:string,expiry?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ref;
    /** @type {string} */
    name;
    /** @type {LicenseType} */
    type;
    /** @type {number} */
    meta;
    /** @type {string} */
    hash;
    /** @type {string} */
    halg;
    /** @type {string} */
    expiry;
}
export class Subscription {
    /** @param {{id?:number,customerId?:number,email?:string,skuId?:number,skuName?:string,skuType?:SkuType,code?:string,quantity?:number,supportQuantity?:number,total?:number,isPlan?:boolean,isRenewal?:boolean,subscriptionDurationDays?:number,renewalDate?:string,licenseRef?:string,licenseName?:string,licenseAddress?:string,licenseType?:LicenseType,expiryDate?:string,licenseKey?:LicenseKey,licenseKeyText?:string,createdDate?:string,modifiedDate?:string,cancelledDate?:string,stripeSubscriptionId?:string,emailId?:number,emailRenewalId?:number,emailExpiredId?:number,renewalSubscriptionId?:number,externalRef?:string,notes?:string,error?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {number} */
    customerId;
    /** @type {string} */
    email;
    /** @type {number} */
    skuId;
    /** @type {string} */
    skuName;
    /** @type {SkuType} */
    skuType;
    /** @type {string} */
    code;
    /** @type {number} */
    quantity;
    /** @type {number} */
    supportQuantity;
    /** @type {number} */
    total;
    /** @type {boolean} */
    isPlan;
    /** @type {boolean} */
    isRenewal;
    /** @type {number} */
    subscriptionDurationDays;
    /** @type {?string} */
    renewalDate;
    /** @type {string} */
    licenseRef;
    /** @type {string} */
    licenseName;
    /** @type {string} */
    licenseAddress;
    /** @type {LicenseType} */
    licenseType;
    /** @type {string} */
    expiryDate;
    /** @type {LicenseKey} */
    licenseKey;
    /** @type {string} */
    licenseKeyText;
    /** @type {string} */
    createdDate;
    /** @type {string} */
    modifiedDate;
    /** @type {?string} */
    cancelledDate;
    /** @type {string} */
    stripeSubscriptionId;
    /** @type {?number} */
    emailId;
    /** @type {?number} */
    emailRenewalId;
    /** @type {?number} */
    emailExpiredId;
    /** @type {?number} */
    renewalSubscriptionId;
    /** @type {string} */
    externalRef;
    /** @type {string} */
    notes;
    /** @type {string} */
    error;
}
export class Customer {
    /** @param {{id?:number,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?:string,isReferrer?:boolean,orders?:Order[],subscriptions?:Subscription[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {string} */
    email;
    /** @type {string} */
    displayName;
    /** @type {string} */
    firstName;
    /** @type {string} */
    lastName;
    /** @type {string} */
    company;
    /** @type {string} */
    phoneNumber;
    /** @type {string} */
    addressLine1;
    /** @type {string} */
    addressLine2;
    /** @type {string} */
    addressCity;
    /** @type {string} */
    addressZip;
    /** @type {string} */
    addressState;
    /** @type {string} */
    addressCountry;
    /** @type {string} */
    stripeCustomerId;
    /** @type {string} */
    stripeCouponId;
    /** @type {string} */
    plan;
    /** @type {string} */
    createdDate;
    /** @type {boolean} */
    isReferrer;
    /** @type {Order[]} */
    orders;
    /** @type {Subscription[]} */
    subscriptions;
}

JavaScript Customer DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
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":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","modifiedDate":"\/Date(-62135596800000-0000)\/","modifiedBy":"String","cancelledDate":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","licenseRef":"String","licenseName":"String","licenseAddress":"String","licenseType":"Free","expiryDate":"\/Date(-62135596800000-0000)\/","licenseKey":{"ref":"String","name":"String","type":"Free","meta":0,"hash":"String","halg":"String","expiry":"\/Date(-62135596800000-0000)\/"},"licenseKeyText":"String","createdDate":"\/Date(-62135596800000-0000)\/","modifiedDate":"\/Date(-62135596800000-0000)\/","cancelledDate":"\/Date(-62135596800000-0000)\/","stripeSubscriptionId":"String","emailId":0,"emailRenewalId":0,"emailExpiredId":0,"renewalSubscriptionId":0,"externalRef":"String","notes":"String","error":"String"}]}