Create a subscription
Creates a recurring payment. A successful request to this endpoint will process an intial transaction and schedule recurring transactions. All transactions will be processed with the values provided in the payment
object. Scheduled transaction will be run according to the values provided in the schedule
object.
⚠️
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 at least a saved card token in thetokenex.token
parameter, the amount and currency for the transaction, and a customer reference number. You should also include the appropriate subscription parameters.
Request parameters
- payment
- payment.data
- payment.data.amount
- 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.orderDate
- 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.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.paymentMethod
- 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.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.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.tokenex
- payment.tokenex.token
- payment.tokenex.firstSix
- payment.tokenex.lastFour
- payment.tokenex.customerRefNumber
- payment.isAuthOnly
- 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.duration
- schedule.dateInitialBillingEnd
- schedule.intialBillingAmount
Response parameters
- customerRef
- 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.orderDate
- 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.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
- paymentResponse
- paymentResponse.id
- paymentResponse.merchantId
- paymentResponse.authCode
- paymentResponse.amount
- paymentResponse.currency
- paymentResponse.transactionDate
- paymentResponse.transactionStatus
- paymentResponse.transactionType
- paymentResponse.shouldUpdateCard
- paymentResponse.card
- paymentResponse.card.cardType
- paymentResponse.card.cardHolder
- paymentResponse.card.cardNumber
- paymentResponse.card.expirationMonth
- paymentResponse.card.expirationYear
- paymentResponse.token
- paymentResponse.token.firstSix
- paymentResponse.token.lastFour
- paymentResponse.token.token
- paymentResponse.token.cardType
- paymentResponse.data
- paymentResponse.data.amount
- paymentResponse.data.currency
- paymentResponse.data.settlementCurrency
- paymentResponse.data.customer
- paymentResponse.data.customer.customerRef
- paymentResponse.data.customer.orderNumber
- paymentResponse.data.customer.orderDate
- paymentResponse.data.customer.invoice
- paymentResponse.data.customer.firstName
- paymentResponse.data.customer.lastName
- paymentResponse.data.customer.birthDate
- paymentResponse.data.customer.email
- paymentResponse.data.customer.phone
- paymentResponse.data.customer.billToAddressOne
- paymentResponse.data.customer.billToAddressTwo
- paymentResponse.data.customer.billToCity
- paymentResponse.data.customer.billToState
- paymentResponse.data.customer.billToPostal
- paymentResponse.data.customer.billToCountry
- paymentResponse.data.customer.billToPhone
- paymentResponse.data.customer.shipToAddressOne
- paymentResponse.data.customer.shipToAddressTwo
- paymentResponse.data.customer.shipToCity
- paymentResponse.data.customer.shipToState
- paymentResponse.data.customer.shipToPostal
- paymentResponse.data.customer.shipToCountry
- paymentResponse.data.customer.shipToPhone
- paymentResponse.data.customer.createdAt
- paymentResponse.data.cart
- paymentResponse.data.cart.items
- paymentResponse.data.cart.items.item
- paymentResponse.data.cart.items.description
- paymentResponse.data.cart.items.quantity
- paymentResponse.data.cart.items.price
- paymentResponse.data.cart.items.type
- paymentResponse.data.lodging
- paymentResponse.data.lodging.advanceDeposit
- paymentResponse.data.lodging.checkInDate
- paymentResponse.data.lodging.checkOutDate
- paymentResponse.data.lodging.noShow
- paymentResponse.data.lodging.roomNumber
- paymentResponse.data.lodging.roomRate
- paymentResponse.data.customFields
- paymentResponse.data.customFields.exampleKey
- paymentResponse.kountResponse
- paymentResponse.kountResponse.status
- paymentResponse.kountResponse.rules
- paymentResponse.installment
- paymentResponse.installment.period
- paymentResponse.gatewayResponse
- paymentResponse.gatewayResponse.gatewayName
- paymentResponse.gatewayResponse.refNumber
- userName
- dateCreated
- dateLastModified
- dateLastRun
- dateNextRun