Sign in
Subscriptions

View customer subscriptions

Returns a list of subscriptions and payment plans for a given customer reference number. This customerRef must have been used when creating the subscription or payment plan (see the Create a subscription endpoint).

<!-- theme: warning -->

⚠️ Try It

To use the Try It feature for this endpoint, you can use the credentials for your Sandbox API user.<br/><br/>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: docs@nexiopay.com password: JZdzoXpdDeH6VA<br/><br/>Include a customer reference number in the path parameter of the request for a subscription created by the test account.

<div style="display:none;">

Request parameters

  • customerRef

Response parameters

  • customerRef
  • active
  • accountId
  • id
  • payment
  • payment.tokenex
  • payment.tokenex.token
  • payment.tokenex.firstSix
  • payment.tokenex.lastFour
  • payment.shouldUpdateCard
  • payment.isAuthOnly
  • payment.processingOptions
  • payment.processingOptions.saveCardToken
  • payment.processingOptions.retryOnSoftDecline
  • payment.processingOptions.checkFraud
  • payment.processingOptions.shouldUseFingerprint
  • payment.processingOptions.check3ds
  • payment.processingOptions.verboseResponse
  • payment.processingOptions.paymentType
  • payment.processingOptions.paymentOptionTag
  • payment.processingOptions.merchantId
  • payment.processingOptions.customerRedirectUrl
  • payment.data
  • payment.data.amount
  • payment.data.currency
  • payment.data.settlementCurrency
  • payment.data.customer
  • payment.data.customer.customerRef
  • payment.data.customer.invoice
  • payment.data.customer.orderNumber
  • payment.data.customer.orderDate
  • payment.data.customer.birthDate
  • payment.data.customer.nationalIdentificationNumber
  • payment.data.customer.companyName
  • payment.data.customer.firstName
  • payment.data.customer.lastName
  • 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.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.customer.createdAtDate
  • schedule
  • schedule.interval
  • schedule.intervalCount
  • schedule.initialBalance
  • schedule.balance
  • schedule.duration
  • schedule.dateInitialBillingEnd
  • schedule.intialBillingAmount
  • schedule.dateCancelAfter
  • schedule.scheduleType
  • userName
  • dateCreated
  • dateLastModified
  • dateLastRun
  • dateNextRun
  • paymentResult
  • paymentResult.amount
  • paymentResult.authCode
  • paymentResult.transactionStatus
  • paymentResult.transactionDate
  • paymentResult.transactionType
  • paymentResult.merchantId
  • paymentResult.currency
  • paymentResult.id
  • paymentResult.asyncTraceId
  • paymentResult.redirectUrl
  • paymentResult.message
  • paymentResult.status
  • paymentResult.gatewayResponse
  • paymentResult.gatewayResponse.gatewayName
  • paymentResult.gatewayResponse.refNumber
  • paymentResult.data
  • paymentResult.data.amount
  • paymentResult.data.currency
  • paymentResult.data.settlementCurrency
  • paymentResult.data.customer
  • paymentResult.data.customer.customerRef
  • paymentResult.data.customer.orderNumber
  • paymentResult.data.customer.orderDate
  • paymentResult.data.customer.invoice
  • paymentResult.data.customer.birthDate
  • paymentResult.data.customer.nationalIdentificationNumber
  • paymentResult.data.customer.companyName
  • paymentResult.data.customer.firstName
  • paymentResult.data.customer.lastName
  • paymentResult.data.customer.email
  • paymentResult.data.customer.phone
  • paymentResult.data.customer.billToAddressOne
  • paymentResult.data.customer.billToAddressTwo
  • paymentResult.data.customer.billToCity
  • paymentResult.data.customer.billToState
  • paymentResult.data.customer.billToPostal
  • paymentResult.data.customer.billToCountry
  • paymentResult.data.customer.billToPhone
  • paymentResult.data.customer.shipToAddressOne
  • paymentResult.data.customer.shipToAddressTwo
  • paymentResult.data.customer.shipToCity
  • paymentResult.data.customer.shipToState
  • paymentResult.data.customer.shipToPostal
  • paymentResult.data.customer.shipToCountry
  • paymentResult.data.customer.shipToPhone
  • paymentResult.data.customer.createdAt
  • paymentResult.card
  • paymentResult.card.cardHolder
  • paymentResult.card.cardNumber
  • paymentResult.card.expirationMonth
  • paymentResult.card.expirationYear
  • paymentResult.token
  • paymentResult.token.firstSix
  • paymentResult.token.lastFour
  • paymentResult.token.token
  • paymentResult.kountResponse
  • paymentResult.kountResponse.status
  • paymentResult.kountResponse.rules
  • lastPaymentStatus
  • lastSuccessfulPaymentDate
  • exp
</div>
get/subscription/v3/customerRef/{customerRef}

Path parameters

customerRefstring required
Example:RP006

The customer reference number used when creating the subscription or payment plan.

Response

Success

customerRefCustomerRef — unresolved $ref
activeActive — unresolved $ref
accountIdAccountId — unresolved $ref
idId — unresolved $ref
scheduleSchedule — unresolved $ref
userNameUserName — unresolved $ref
dateCreatedDateCreated — unresolved $ref
dateLastModifiedDateLastModified — unresolved $ref
dateLastRunDateLastRun — unresolved $ref
dateNextRunDateNextRun — unresolved $ref
paymentResultPaymentResult — unresolved $ref
lastPaymentStatusLastPaymentStatus — unresolved $ref
lastSuccessfulPaymentDateLastSuccessfulPaymentDate — unresolved $ref
expExp — unresolved $ref
randomRandomNnnn — unresolved $ref

Changes