IMimis
AutoPayInstruction

Updates an AutoPayInstruction by id

Updates an instance of AutoPayInstruction by id

put/AutoPayInstruction/{InstructionId}

Request

  • Base URL
    https://yourorgsite.com/api
  • URL
    https://yourorgsite.com/api/AutoPayInstruction/{InstructionId}
  • Auth
    OAuth 2
    Implicit: https://yourorgsite.com

Path parameters

InstructionIdstring required

Id of AutoPayInstruction to be Updated

Request body

$type'Asi.Soa.Commerce.DataContracts.AutoPayInstructionData, Asi.Contracts' required

The DataType must be "Asi.Soa.Commerce.DataContracts.AutoPayInstructionData, Asi.Contracts"

Amountobject
AutoPayAccountIdstring
BillingCycleNamestring
CancellationReasonstring
CancelledOnstring date-time
CollectionDayinteger
EditMessagestring
EndDatestring date-time
ExternalInstructionIdstring
ExternalTokenstring
InstructionIdstring
InstructionType'Donation' | 'Membership' | 'Subscription'
IntervalTypeCode'Yearly' | 'Quarterly' | 'Monthly' | 'Weekly' | 'Daily' | 'EventDriven' | 'Once' | 'Custom'
IsInstructionEditableboolean
PaymentTermsKeystring
ProcessingReferencestring
ProductCodestring
SourceCodestring
StartDatestring date-time
Statusstring

Response

The request was successful.

Changes

No recorded changes to this operation across all 1 revision of this API.