ServiceStack Home (Live)

<back to all web services

Renew

The following routes are available for this service:
All Verbs/renew
All Verbs/Renew
import 'package:servicestack/servicestack.dart';

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

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 RenewResponse implements IConvertible
{
    List<Subscription>? subscriptions;
    ResponseStatus? responseStatus;

    RenewResponse({this.subscriptions,this.responseStatus});
    RenewResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        subscriptions = JsonConverters.fromJson(json['subscriptions'],'List<Subscription>',context!);
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'subscriptions': JsonConverters.toJson(subscriptions,'List<Subscription>',context!),
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

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

class Renew implements IGet, IConvertible
{
    String? licenseRef;
    String? licenseKey;
    String? error;

    Renew({this.licenseRef,this.licenseKey,this.error});
    Renew.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        licenseRef = json['licenseRef'];
        licenseKey = json['licenseKey'];
        error = json['error'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'licenseRef': licenseRef,
        'licenseKey': licenseKey,
        'error': error
    };

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

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

Dart Renew DTOs

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 /renew HTTP/1.1 
Host: account.servicestack.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Renew xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
  <Error>String</Error>
  <LicenseKey>String</LicenseKey>
  <LicenseRef>String</LicenseRef>
</Renew>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RenewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <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>
</RenewResponse>