TicketUserServices

RunRecurringChargeJobRequest

**Requires Authentication**
Requires the role:	Admin

The following routes are available for this service:
POST	/recurringPayments/run-charge

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecurringChargeJobSummary:
    master_enabled: Optional[bool] = None
    auto_submit_enabled: Optional[bool] = None
    dunning_enabled: Optional[bool] = None
    expire_lapsed_enabled: Optional[bool] = None
    end_of_term_revoke_enabled: Optional[bool] = None
    charge_hour: Optional[int] = None
    batch_size: Optional[int] = None
    as_of_utc: Optional[datetime.datetime] = None
    dry_run: Optional[bool] = None
    charge_live: Optional[bool] = None
    dunning_live: Optional[bool] = None
    charged: Optional[int] = None
    declined: Optional[int] = None
    ambiguous: Optional[int] = None
    skipped_already_charged: Optional[int] = None
    null_owner_charged: Optional[int] = None
    skipped_single_payment: Optional[int] = None
    expired_cards: Optional[int] = None
    end_of_term_closed: Optional[int] = None
    end_of_term_revoked: Optional[int] = None
    hard_closed: Optional[int] = None
    capped_closed: Optional[int] = None
    expired_card_notified: Optional[int] = None
    check_first: Optional[int] = None
    circuit_broken: Optional[bool] = None
    circuit_breaker_code: Optional[str] = None
    would_charge: Optional[int] = None
    would_stop_hard: Optional[int] = None
    would_stop_capped: Optional[int] = None
    would_sms: Optional[int] = None
    would_email: Optional[int] = None
    would_close: Optional[int] = None
    would_expire: Optional[int] = None
    would_end_of_term_close: Optional[int] = None
    would_end_of_term_revoke: Optional[int] = None
    sms_sent: Optional[int] = None
    emails: Optional[int] = None
    closed: Optional[int] = None
    log: Optional[List[str]] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RunRecurringChargeJobRequest:
    dry_run: Optional[bool] = None
    as_of: Optional[datetime.datetime] = None

Python RunRecurringChargeJobRequest 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 /recurringPayments/run-charge HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	dryRun: False,
	asOf: 0001-01-01
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	masterEnabled: False,
	autoSubmitEnabled: False,
	dunningEnabled: False,
	expireLapsedEnabled: False,
	endOfTermRevokeEnabled: False,
	chargeHour: 0,
	batchSize: 0,
	asOfUtc: 0001-01-01,
	dryRun: False,
	chargeLive: False,
	dunningLive: False,
	charged: 0,
	declined: 0,
	ambiguous: 0,
	skippedAlreadyCharged: 0,
	nullOwnerCharged: 0,
	skippedSinglePayment: 0,
	expiredCards: 0,
	endOfTermClosed: 0,
	endOfTermRevoked: 0,
	hardClosed: 0,
	cappedClosed: 0,
	expiredCardNotified: 0,
	checkFirst: 0,
	circuitBroken: False,
	circuitBreakerCode: String,
	wouldCharge: 0,
	wouldStopHard: 0,
	wouldStopCapped: 0,
	wouldSms: 0,
	wouldEmail: 0,
	wouldClose: 0,
	wouldExpire: 0,
	wouldEndOfTermClose: 0,
	wouldEndOfTermRevoke: 0,
	smsSent: 0,
	emails: 0,
	closed: 0,
	log: 
	[
		String
	],
	statusCode: 0,
	message: String
}