POST
/
subscription
/
create
curl --request POST \
  --url https://api.xpaycheckout.com/subscription/create \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 100,
  "currency": "USD",
  "receiptId": "order123",
  "customerDetails": {
    "name": "John Doe",
    "email": "john.doe@example.com",
    "contactNumber": "9123456789",
    "customerAddress": {
      "country": "US",
      "postalCode": "2424"
    }
  },
  "description": "Order for 2 items",
  "callbackUrl": "https://example.com/callback",
  "cancelUrl": "https://example.com/cancel",
  "interval": "MONTH",
  "intervalCount": 2,
  "cycleCount": 2,
  "upfrontAmount": 200,
  "metadata": {
    "orderId": "12345",
    "customerNote": "Deliver after 5 PM"
  }
}'
{
  "subscriptionId": "66f53a6e2097773e4f0112c8",
  "createdAt": "2024-09-26T10:41:50.472+00:00",
  "fwdUrl": "https://pay.xpaycheckout.com/?subscription_id=67f53a6e2097773e4f0112c8"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
Create Subscription
​
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)

Example:

100

​
currency
string
required

Three letter abbreviation of the currency. Refer supported currencies

Example:

"USD"

​
customerDetails
object
required

Details about the customer

​
callbackUrl
string
required

The URL we will callback to with the order status once it finishes.

Example:

"https://example.com/callback"

​
interval
enum<string>
required

The interval group between subscriptions.

Available options:
DAY,
WEEK,
MONTH,
YEAR
Example:

"MONTH"

​
intervalCount
integer
required

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

Example:

2

​
cycleCount
integer
required

The number of billing cycles for which the subscription will renew before ending. The first cycle is included in this count.

Example:

2

​
receiptId
string

Your identifier of the order

Example:

"order123"

​
description
string

Description of the order, if any

Example:

"Order for 2 items"

​
cancelUrl
string

The URL to redirect the customer to when they cancel the subscription. If not provided, the callbackUrl will be used as fallback.

Example:

"https://example.com/cancel"

​
upfrontAmount
integer

The amount to be charged at the start of the subscription. The upfront amount replaces the first subscription cycle amount. Regular amount apply from the next cycle.

Example:

200

​
metadata
object

A collection of key-value pairs that can be attached to an object for storing additional structured information. This is useful for capturing custom data or context-specific attributes.

Constraints:

  • Maximum of 50 key-value pairs allowed.
  • Each key must be no longer than 40 characters.
  • Each value must be a string and cannot exceed 500 characters.
Example:
{
  "orderId": "12345",
  "customerNote": "Deliver after 5 PM"
}

Response

200
application/json
Create Subscription response
​
subscriptionId
string

Unique identifier of the subscription

Example:

"66f53a6e2097773e4f0112c8"

​
createdAt
string

Timestamp of when the subscription was created

Example:

"2024-09-26T10:41:50.472+00:00"

​
fwdUrl
string

The URL to redirect the customer to the xPay payment gateway for payment.

Example:

"https://pay.xpaycheckout.com/?subscription_id=67f53a6e2097773e4f0112c8"

Was this page helpful?