Updates an existing payment subscription. Card token, currency, amount, and customer reference cannot be updated. If you need to change any of these values, delete the existing subscription and create a new one. The only user with rights to edit the subscription is the original creator.
⚠️
Try It
To use the Try It feature for this endpoint, you can use your own Sandbox credentials.
You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right.
username: [email protected]
password: JZdzoXpdDeH6VA
Include a subscription ID in the path parameter of the request.
Request parameters
id
Response parameters
customerRef
active
accountId
id
payment
payment.isAuthOnly
payment.data
payment.data.amount
payment.data.cart
payment.data.cart.items
payment.data.cart.items.item
payment.data.cart.items.description
payment.data.cart.items.quantity
payment.data.cart.items.price
payment.data.cart.items.type
payment.data.currency
payment.data.customer
payment.data.customer.customerRef
payment.data.customer.firstName
payment.data.customer.lastName
payment.data.customer.invoice
payment.data.customer.orderNumber
payment.data.customer.birthDate
payment.data.customer.createdAtDate
payment.data.customer.email
payment.data.customer.phone
payment.data.customer.billToAddressOne
payment.data.customer.billToAddressTwo
payment.data.customer.billToCity
payment.data.customer.billToState
payment.data.customer.billToPostal
payment.data.customer.billToCountry
payment.data.customer.billToPhone
payment.data.customer.orderDate
payment.data.customer.shipToAddressOne
payment.data.customer.shipToAddressTwo
payment.data.customer.shipToCity
payment.data.customer.shipToState
payment.data.customer.shipToPostal
payment.data.customer.shipToCountry
payment.data.customer.shipToPhone
payment.data.customFields
payment.data.customFields.exampleKey
payment.data.description
payment.data.descriptor
payment.data.descriptor.name
payment.data.descriptor.address
payment.data.descriptor.city
payment.data.descriptor.state
payment.data.descriptor.postal
payment.data.descriptor.country
payment.data.descriptor.phone
payment.data.descriptor.url
payment.data.descriptor.merchantId
payment.data.descriptor.mcc
payment.data.lodging
payment.data.lodging.advanceDeposit
payment.data.lodging.checkInDate
payment.data.lodging.checkOutDate
payment.data.lodging.noShow
payment.data.lodging.roomNumber
payment.data.lodging.roomRate
payment.tokenex
payment.tokenex.token
payment.tokenex.firstSix
payment.tokenex.lastFour
payment.processingOptions
payment.processingOptions.checkFraud
payment.processingOptions.merchantId
payment.processingOptions.paymentOptionTag
payment.processingOptions.shouldUseFingerprint
payment.processingOptions.retryOnSoftDecline
payment.processingOptions.verboseResponse
schedule
schedule.interval
schedule.intervalCount
schedule.balance
schedule.initialBalance
schedule.duration
schedule.dateInitialBillingEnd
schedule.intialBillingAmount
userName
dateCreated
dateLastModified
dateLastRun
dateNextRun
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!
