TicketUserServices

<back to all web services

RecurringPaymentListRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdmin
The following routes are available for this service:
GET/recurringPayments
import 'package:servicestack/servicestack.dart';

class RecurringPayment implements IConvertible
{
    int? id;
    String? status;
    String? phoneVerificationNumber;
    String? deviceId;
    String? panLastFour;
    String? expYear;
    String? expMonth;
    String? token;
    int? monthlyPrice;
    int? subscriptionLength;
    int? monthsPaid;
    bool? chargeFirstMonth;
    // @References(typeof(EventOwner))
    int? ownerId;

    int? ownerCardTypeId;
    // @StringLength(2147483647)
    String? jsonResponse;

    DateTime? startDate;
    DateTime? lastPayment;
    DateTime? nextPayment;
    String? paymentTokenId;
    int? declinedCounter;
    double? transactionFee;
    String? termsVersion;
    DateTime? termsAcceptedAt;
    String? currency;
    String? mode;
    String? lastDeclineReason;
    DateTime? lastDeclineDate;
    int? lastDunningStage;
    DateTime? lastDunningNotifiedAt;

    RecurringPayment({this.id,this.status,this.phoneVerificationNumber,this.deviceId,this.panLastFour,this.expYear,this.expMonth,this.token,this.monthlyPrice,this.subscriptionLength,this.monthsPaid,this.chargeFirstMonth,this.ownerId,this.ownerCardTypeId,this.jsonResponse,this.startDate,this.lastPayment,this.nextPayment,this.paymentTokenId,this.declinedCounter,this.transactionFee,this.termsVersion,this.termsAcceptedAt,this.currency,this.mode,this.lastDeclineReason,this.lastDeclineDate,this.lastDunningStage,this.lastDunningNotifiedAt});
    RecurringPayment.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        status = json['status'];
        phoneVerificationNumber = json['phoneVerificationNumber'];
        deviceId = json['deviceId'];
        panLastFour = json['panLastFour'];
        expYear = json['expYear'];
        expMonth = json['expMonth'];
        token = json['token'];
        monthlyPrice = json['monthlyPrice'];
        subscriptionLength = json['subscriptionLength'];
        monthsPaid = json['monthsPaid'];
        chargeFirstMonth = json['chargeFirstMonth'];
        ownerId = json['ownerId'];
        ownerCardTypeId = json['ownerCardTypeId'];
        jsonResponse = json['jsonResponse'];
        startDate = JsonConverters.fromJson(json['startDate'],'DateTime',context!);
        lastPayment = JsonConverters.fromJson(json['lastPayment'],'DateTime',context!);
        nextPayment = JsonConverters.fromJson(json['nextPayment'],'DateTime',context!);
        paymentTokenId = json['paymentTokenId'];
        declinedCounter = json['declinedCounter'];
        transactionFee = JsonConverters.toDouble(json['transactionFee']);
        termsVersion = json['termsVersion'];
        termsAcceptedAt = JsonConverters.fromJson(json['termsAcceptedAt'],'DateTime',context!);
        currency = json['currency'];
        mode = json['mode'];
        lastDeclineReason = json['lastDeclineReason'];
        lastDeclineDate = JsonConverters.fromJson(json['lastDeclineDate'],'DateTime',context!);
        lastDunningStage = json['lastDunningStage'];
        lastDunningNotifiedAt = JsonConverters.fromJson(json['lastDunningNotifiedAt'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'status': status,
        'phoneVerificationNumber': phoneVerificationNumber,
        'deviceId': deviceId,
        'panLastFour': panLastFour,
        'expYear': expYear,
        'expMonth': expMonth,
        'token': token,
        'monthlyPrice': monthlyPrice,
        'subscriptionLength': subscriptionLength,
        'monthsPaid': monthsPaid,
        'chargeFirstMonth': chargeFirstMonth,
        'ownerId': ownerId,
        'ownerCardTypeId': ownerCardTypeId,
        'jsonResponse': jsonResponse,
        'startDate': JsonConverters.toJson(startDate,'DateTime',context!),
        'lastPayment': JsonConverters.toJson(lastPayment,'DateTime',context!),
        'nextPayment': JsonConverters.toJson(nextPayment,'DateTime',context!),
        'paymentTokenId': paymentTokenId,
        'declinedCounter': declinedCounter,
        'transactionFee': transactionFee,
        'termsVersion': termsVersion,
        'termsAcceptedAt': JsonConverters.toJson(termsAcceptedAt,'DateTime',context!),
        'currency': currency,
        'mode': mode,
        'lastDeclineReason': lastDeclineReason,
        'lastDeclineDate': JsonConverters.toJson(lastDeclineDate,'DateTime',context!),
        'lastDunningStage': lastDunningStage,
        'lastDunningNotifiedAt': JsonConverters.toJson(lastDunningNotifiedAt,'DateTime',context!)
    };

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

class RecurringPaymentListResult implements IConvertible
{
    List<RecurringPayment>? items;
    int? statusCode;
    String? message;

    RecurringPaymentListResult({this.items,this.statusCode,this.message});
    RecurringPaymentListResult.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        items = JsonConverters.fromJson(json['items'],'List<RecurringPayment>',context!);
        statusCode = json['statusCode'];
        message = json['message'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'items': JsonConverters.toJson(items,'List<RecurringPayment>',context!),
        'statusCode': statusCode,
        'message': message
    };

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

class RecurringPaymentListRequest implements IConvertible
{
    int? ownerId;
    String? status;
    String? phoneVerificationNumber;
    int? limit;

    RecurringPaymentListRequest({this.ownerId,this.status,this.phoneVerificationNumber,this.limit});
    RecurringPaymentListRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ownerId = json['ownerId'];
        status = json['status'];
        phoneVerificationNumber = json['phoneVerificationNumber'];
        limit = json['limit'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ownerId': ownerId,
        'status': status,
        'phoneVerificationNumber': phoneVerificationNumber,
        'limit': limit
    };

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

TypeContext _ctx = TypeContext(library: 'stubbur_app.azurewebsites.net', types: <String, TypeInfo> {
    'RecurringPayment': TypeInfo(TypeOf.Class, create:() => RecurringPayment()),
    'RecurringPaymentListResult': TypeInfo(TypeOf.Class, create:() => RecurringPaymentListResult()),
    'List<RecurringPayment>': TypeInfo(TypeOf.Class, create:() => <RecurringPayment>[]),
    'RecurringPaymentListRequest': TypeInfo(TypeOf.Class, create:() => RecurringPaymentListRequest()),
});

Dart RecurringPaymentListRequest 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.

GET /recurringPayments HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RecurringPaymentListResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel.Types.Payouts">
    <d2p1:RecurringPayment>
      <d2p1:ChargeFirstMonth>false</d2p1:ChargeFirstMonth>
      <d2p1:Currency>String</d2p1:Currency>
      <d2p1:DeclinedCounter>0</d2p1:DeclinedCounter>
      <d2p1:DeviceId>String</d2p1:DeviceId>
      <d2p1:ExpMonth>String</d2p1:ExpMonth>
      <d2p1:ExpYear>String</d2p1:ExpYear>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:JsonResponse>String</d2p1:JsonResponse>
      <d2p1:LastDeclineDate>0001-01-01T00:00:00</d2p1:LastDeclineDate>
      <d2p1:LastDeclineReason>String</d2p1:LastDeclineReason>
      <d2p1:LastDunningNotifiedAt>0001-01-01T00:00:00</d2p1:LastDunningNotifiedAt>
      <d2p1:LastDunningStage>0</d2p1:LastDunningStage>
      <d2p1:LastPayment>0001-01-01T00:00:00</d2p1:LastPayment>
      <d2p1:Mode>String</d2p1:Mode>
      <d2p1:MonthlyPrice>0</d2p1:MonthlyPrice>
      <d2p1:MonthsPaid>0</d2p1:MonthsPaid>
      <d2p1:NextPayment>0001-01-01T00:00:00</d2p1:NextPayment>
      <d2p1:OwnerCardTypeId>0</d2p1:OwnerCardTypeId>
      <d2p1:OwnerId>0</d2p1:OwnerId>
      <d2p1:PanLastFour>String</d2p1:PanLastFour>
      <d2p1:PaymentTokenId>String</d2p1:PaymentTokenId>
      <d2p1:PhoneVerificationNumber>String</d2p1:PhoneVerificationNumber>
      <d2p1:StartDate>0001-01-01T00:00:00</d2p1:StartDate>
      <d2p1:Status>String</d2p1:Status>
      <d2p1:SubscriptionLength>0</d2p1:SubscriptionLength>
      <d2p1:TermsAcceptedAt>0001-01-01T00:00:00</d2p1:TermsAcceptedAt>
      <d2p1:TermsVersion>String</d2p1:TermsVersion>
      <d2p1:Token>String</d2p1:Token>
      <d2p1:TransactionFee>0</d2p1:TransactionFee>
    </d2p1:RecurringPayment>
  </Items>
  <Message>String</Message>
  <StatusCode>0</StatusCode>
</RecurringPaymentListResult>