POST
/
subscription
/
link
/
merchant
/
generate-link

Authorizations

Authorization
string
headerrequired

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
amount
integer
required

The amount in lowest count unit. e.g.: For USD 1, amount is 100 representing 100 cents (The minimum amount should be greater than 1 USD)

currency
enum<string>
required

Three letter abbreviation of the currency.

Available options:
USD
receiptId
string

Your identifier of the order

customerDetails
object
required

Details about the customer

description
string

The description of the order, if any

expiryDate
integer
required

Timestamp in epoch milliseconds, indicating the expiration time of the link

interval
enum<string>
required

The interval group between subscriptions.

Available options:
DAY,
WEEK,
MONTH,
YEAR
intervalCount
integer
required

The number of intervals between subscription billings. For example, interval = MONTH and intervalCount = 3 bills every 3 months.

cycleCount
integer
required

The number of billing cycles for which the subscription will renew before ending.

Response

200 - application/json
shortUrl
string

The shortened URL generated by the xPay API. This link can be shared with customers for completing payments.

Was this page helpful?

Cancel SubscriptionPayments Links