Create a payment

POST

payments

Create a payment

curl --request POST \
  --url https://sandbox-api.paynext.com/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Version: <x-api-version>' \
  --data '
{
  "customer": {
    "id": "cus_11dfa45f-23b1-40f4-9e9b-c9d485915528"
  },
  "metadata": {
    "key": "value"
  },
  "plan": {
    "id": "price_3501fda3-7c64-41d2-9c36-23c4941311f3"
  },
  "price": {
    "amount": 1999,
    "currency": "AED"
  }
}
'

const options = {
  method: 'POST',
  headers: {
    'X-API-Version': '<x-api-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    customer: {id: 'cus_11dfa45f-23b1-40f4-9e9b-c9d485915528'},
    metadata: {key: 'value'},
    plan: {id: 'price_3501fda3-7c64-41d2-9c36-23c4941311f3'},
    price: {amount: 1999, currency: 'AED'}
  })
};

fetch('https://sandbox-api.paynext.com/payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.paynext.com/payments"

	payload := strings.NewReader("{\n  \"customer\": {\n    \"id\": \"cus_11dfa45f-23b1-40f4-9e9b-c9d485915528\"\n  },\n  \"metadata\": {\n    \"key\": \"value\"\n  },\n  \"plan\": {\n    \"id\": \"price_3501fda3-7c64-41d2-9c36-23c4941311f3\"\n  },\n  \"price\": {\n    \"amount\": 1999,\n    \"currency\": \"AED\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Version", "<x-api-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox-api.paynext.com/payments")
  .header("X-API-Version", "<x-api-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer\": {\n    \"id\": \"cus_11dfa45f-23b1-40f4-9e9b-c9d485915528\"\n  },\n  \"metadata\": {\n    \"key\": \"value\"\n  },\n  \"plan\": {\n    \"id\": \"price_3501fda3-7c64-41d2-9c36-23c4941311f3\"\n  },\n  \"price\": {\n    \"amount\": 1999,\n    \"currency\": \"AED\"\n  }\n}")
  .asString();

import requests

url = "https://sandbox-api.paynext.com/payments"

payload = {
    "customer": { "id": "cus_11dfa45f-23b1-40f4-9e9b-c9d485915528" },
    "metadata": { "key": "value" },
    "plan": { "id": "price_3501fda3-7c64-41d2-9c36-23c4941311f3" },
    "price": {
        "amount": 1999,
        "currency": "AED"
    }
}
headers = {
    "X-API-Version": "<x-api-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.paynext.com/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customer' => [
        'id' => 'cus_11dfa45f-23b1-40f4-9e9b-c9d485915528'
    ],
    'metadata' => [
        'key' => 'value'
    ],
    'plan' => [
        'id' => 'price_3501fda3-7c64-41d2-9c36-23c4941311f3'
    ],
    'price' => [
        'amount' => 1999,
        'currency' => 'AED'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-API-Version: <x-api-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "amount": 15000,
  "amount_usd": 15000,
  "avs_check": {
    "result": {
      "postal_code": "pass",
      "street_address": "pass"
    }
  },
  "created_at": "2025-05-25T14:30:00Z",
  "currency_code": "AED",
  "customer": {
    "address": {
      "city": "San Francisco",
      "country": "AD",
      "line1": "123 Market Street",
      "line2": "Suite 400",
      "postal_code": "94105",
      "state": "CA"
    },
    "created_at": "2025-05-28T14:00:00Z",
    "email": "alice.johnson@example.com",
    "external_id": "ext_001",
    "full_name": "Alice Johnson",
    "id": "cus_b8d0fe7e-3a7f-4b5f-a68b-d31358b49c3f",
    "metadata": {
      "key": "value"
    },
    "phone": "+1-555-123-4567",
    "updated_at": "2025-05-28T14:05:00Z"
  },
  "cvc_check": {
    "result": {
      "cvc": "pass"
    }
  },
  "disputes": [
    {
      "disputed_at": "2026-08-01T10:15:00Z",
      "external_id": "dp_1Nx2yZAbCdEfGh",
      "id": "dsp_7c1a2b3c-4d5e-6f70-8a9b-0c1d2e3f4a5b",
      "reason": "FRAUDULENT",
      "stage": "DISPUTE",
      "status": "NEEDS_RESPONSE"
    }
  ],
  "id": "pay_e8a1b2c3-d4f5-6789-abcd-ef0123456789",
  "metadata": {
    "key": "value"
  },
  "payment_details": {
    "arn": "123453",
    "auth_code": "334385",
    "network_payment_id": "119676610486528",
    "processor_transaction_id": "pi_3RgN6TJVVBuowJOx0B4fpGWi"
  },
  "payment_method": {
    "details": {
      "bin": "411111",
      "bin_data": {
        "brand": "visa",
        "country": "AD",
        "currency_code": "<string>",
        "description": "Chase Sapphire Preferred",
        "funding": "debit",
        "issuer": "Chase Bank",
        "type": "consumer"
      },
      "exp_month": 12,
      "exp_year": 2028,
      "is_network_tokenized": true,
      "last4": "1111",
      "network_token": {
        "bin": "48953700",
        "last4": "0370",
        "exp_month": 5,
        "exp_year": 31,
        "status": "active",
        "last_synced_at": "2025-05-26T10:15:00Z"
      },
      "number": "4111111111111111"
    },
    "type": "CARD",
    "billing_address": {
      "city": "San Francisco",
      "country": "AD",
      "line1": "123 Market Street",
      "line2": "Suite 400",
      "postal_code": "94105",
      "state": "CA"
    },
    "card_updater": true,
    "fpan_out_of_sync": false,
    "status": "active"
  },
  "payment_status": "PENDING",
  "payment_token_type": "CARD_PAN",
  "payment_type": "MIT",
  "processor": {
    "description": "Stripe US",
    "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "processor_merchant_id": "12345678",
    "type": "STRIPE"
  },
  "refund": {
    "amount": 123,
    "amount_usd": 123,
    "created_at": "<string>",
    "processor_transaction_id": "<string>",
    "status": "PENDING",
    "updated_at": "<string>"
  },
  "refunded_amount": 0,
  "refund_reason": "fraud_prevention",
  "statement_descriptor": "MY COMPANY",
  "status_reason": {
    "status": "declined",
    "status_reason": {
      "advice_code": "do_not_try_again",
      "decline_code": "insufficient_funds",
      "message": "<string>"
    }
  },
  "subscription": {
    "created_at": "2025-05-26T10:00:00Z",
    "current_period_end": "<string>",
    "cancelled_at": "2026-06-10T14:32:08Z",
    "cancellation_details": {
      "reason": "fraud_prevention",
      "trigger_payment_id": "pay_e8a1b2c3-1d2e-3f4a-5b6c-7d8e9f0a1b2c"
    },
    "current_period_start": "<string>",
    "id": "sub_123e4567-e89b-12d3-a456-426614174000",
    "metadata": {
      "key": "value"
    },
    "next_billing_date": "2025-06-26T12:00:00Z",
    "past_due": {
      "attempt_count": 2,
      "max_attempts_count": 7
    },
    "plan": {
      "id": "price_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "interval": "days",
      "interval_count": 1,
      "name": "Pro Plan",
      "price": {
        "amount": 1999,
        "currency": "AED"
      },
      "tax": {
        "collect_tax": "<unknown>"
      },
      "trial_interval": "days",
      "trial_interval_count": 14,
      "trial_price": {
        "amount": 1999,
        "currency": "AED"
      },
      "type": "recurring"
    },
    "status": "trial",
    "updated_at": "2025-05-27T10:00:00Z"
  },
  "tax": {
    "amount_subtotal": 123,
    "amount_subtotal_usd": 123,
    "amount_tax": 123,
    "amount_tax_usd": 123,
    "behavior": "<unknown>",
    "calculation_id": "<string>",
    "error": {
      "code": "<unknown>",
      "message": "<string>"
    },
    "provider": {
      "id": "<string>",
      "type": "NUMERAL"
    },
    "status": "<unknown>",
    "transaction_id": "<string>"
  },
  "three_d_secure": {
    "authentication_flow": "<string>",
    "electronic_commerce_indicator": {
      "liability_shift": true,
      "result": "<string>",
      "value": "<string>"
    },
    "status": "action-required",
    "status_reason": "<string>",
    "transaction_id": "<string>",
    "version": "<string>"
  },
  "updated_at": "2025-05-26T10:15:00Z"
}

{
  "error": {
    "message": "some error message"
  }
}

{
  "error": {
    "message": "some error message"
  }
}

{
  "error": {
    "message": "some error message"
  }
}

Authorizations

Authorization

string

header

required

Authentication header of the form api key, where api key is your organization api key.

Headers

X-API-Version

enum<string>

default:1.0.0

required

Specifies the version of the API to use

Available options:

1.0.0

Body

application/json

Create payment

customer

object

Customer information for the payment

Show child attributes

metadata

object

Custom metadata associated with the payment A dictionary of key-value pairs.

Show child attributes

Example:

{ "key": "value" }

plan

object

Plan information for the payment

Show child attributes

price

object

Optional custom price overriding the plan's configured price. Supported for one-off plans only. amount must be greater than 0 and at most 1000000000000 minor units; otherwise the request returns 400 with the message invalid custom price: amount must be greater than 0 or invalid custom price: amount must not exceed 1000000000000.

Show child attributes

Response

amount

integer

Payment amount in the specified currency (e.g., cents)

Example:

15000

amount_usd

integer

Payment amount converted to USD (e.g., cents)

Example:

15000

avs_check

object

Avs check

Show child attributes

created_at

string

The date and time at which the payment was created in UTC format.

Example:

"2025-05-25T14:30:00Z"

currency_code

enum<string>

The 3-letter currency code in ISO 4217 format. e.g. use USD for US dollars.

Available options:

AED,

AFN,

ALL,

AMD,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLP,

CNY,

COP,

CRC,

CUC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ERN,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HTG,

HUF,

IDR,

ILS,

IMP,

INR,

IQD,

IRR,

ISK,

JEP,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRU,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLE,

SOS,

SRD,

SSP,

STD,

STN,

SVC,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

BOV,

COU,

CHE,

CHW,

MXV,

UGX,

VES,

VND,

VUV,

XAF,

XCD,

XCG,

XOF,

XPF,

YER,

USD

customer

object

Show child attributes

cvc_check

object

CVC check

Show child attributes

disputes

object[]

Disputes linked to this payment. Returned by GET /payments and GET /payments/{id} only; payment webhook payloads never include it. On GET /payments, the key is present only when the payment has at least one dispute. On GET /payments/{id}, an empty array means the payment has no disputes, and an absent key means dispute data could not be loaded for this response, not that the payment has no disputes.

Show child attributes

string

Unique identifier of the payment.

Example:

"pay_e8a1b2c3-d4f5-6789-abcd-ef0123456789"

metadata

object

Custom metadata associated with the payment A dictionary of key-value pairs.

Show child attributes

Example:

{ "key": "value" }

payment_details

object

Transaction details related to payment

Show child attributes

payment_method

Card API Schema · object

Show child attributes

payment_status

enum<string>

Current status of the payment

Available options:

PENDING,

FAILED,

AUTHORIZED,

SETTLING,

SETTLED,

DECLINED,

BLOCKED,

CANCELLED

payment_token_type

enum<string>

Type of card token used, if applicable

Available options:

CARD_PAN,

NETWORK_TOKEN,

PROCESSOR_TOKEN

payment_type

enum<string>

Indicates whether the transaction was merchant-initiated (MIT) or customer-initiated (CIT).

Available options:

MIT,

CIT

processor

object

Show child attributes

refund

object

Information about refund

Show child attributes

refunded_amount

integer

Amount refunded from the original payment

Example:

0

refund_reason

enum<string>

Server-attested reason the payment was refunded; present only once a refund has executed, null otherwise

Available options:

merchant_initiated,

fraud_prevention

Example:

"fraud_prevention"

statement_descriptor

string

Statement descriptor shown on the customer's bank statement

Example:

"MY COMPANY"

status_reason

object

Reason of payment status

Show child attributes

subscription

object

Show child attributes

tax

object

Tax info (provider, calculation/transaction ids, amounts, status)

Show child attributes

three_d_secure

object

Information about 3DS

Show child attributes

updated_at

string

The date and time of the last payment update in UTC format.

Example:

"2025-05-26T10:15:00Z"

⌘I

Create a payment

curl --request POST \
  --url https://sandbox-api.paynext.com/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Version: <x-api-version>' \
  --data '
{
  "customer": {
    "id": "cus_11dfa45f-23b1-40f4-9e9b-c9d485915528"
  },
  "metadata": {
    "key": "value"
  },
  "plan": {
    "id": "price_3501fda3-7c64-41d2-9c36-23c4941311f3"
  },
  "price": {
    "amount": 1999,
    "currency": "AED"
  }
}
'

const options = {
  method: 'POST',
  headers: {
    'X-API-Version': '<x-api-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    customer: {id: 'cus_11dfa45f-23b1-40f4-9e9b-c9d485915528'},
    metadata: {key: 'value'},
    plan: {id: 'price_3501fda3-7c64-41d2-9c36-23c4941311f3'},
    price: {amount: 1999, currency: 'AED'}
  })
};

fetch('https://sandbox-api.paynext.com/payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.paynext.com/payments"

	payload := strings.NewReader("{\n  \"customer\": {\n    \"id\": \"cus_11dfa45f-23b1-40f4-9e9b-c9d485915528\"\n  },\n  \"metadata\": {\n    \"key\": \"value\"\n  },\n  \"plan\": {\n    \"id\": \"price_3501fda3-7c64-41d2-9c36-23c4941311f3\"\n  },\n  \"price\": {\n    \"amount\": 1999,\n    \"currency\": \"AED\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Version", "<x-api-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox-api.paynext.com/payments")
  .header("X-API-Version", "<x-api-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer\": {\n    \"id\": \"cus_11dfa45f-23b1-40f4-9e9b-c9d485915528\"\n  },\n  \"metadata\": {\n    \"key\": \"value\"\n  },\n  \"plan\": {\n    \"id\": \"price_3501fda3-7c64-41d2-9c36-23c4941311f3\"\n  },\n  \"price\": {\n    \"amount\": 1999,\n    \"currency\": \"AED\"\n  }\n}")
  .asString();

import requests

url = "https://sandbox-api.paynext.com/payments"

payload = {
    "customer": { "id": "cus_11dfa45f-23b1-40f4-9e9b-c9d485915528" },
    "metadata": { "key": "value" },
    "plan": { "id": "price_3501fda3-7c64-41d2-9c36-23c4941311f3" },
    "price": {
        "amount": 1999,
        "currency": "AED"
    }
}
headers = {
    "X-API-Version": "<x-api-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.paynext.com/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customer' => [
        'id' => 'cus_11dfa45f-23b1-40f4-9e9b-c9d485915528'
    ],
    'metadata' => [
        'key' => 'value'
    ],
    'plan' => [
        'id' => 'price_3501fda3-7c64-41d2-9c36-23c4941311f3'
    ],
    'price' => [
        'amount' => 1999,
        'currency' => 'AED'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-API-Version: <x-api-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "amount": 15000,
  "amount_usd": 15000,
  "avs_check": {
    "result": {
      "postal_code": "pass",
      "street_address": "pass"
    }
  },
  "created_at": "2025-05-25T14:30:00Z",
  "currency_code": "AED",
  "customer": {
    "address": {
      "city": "San Francisco",
      "country": "AD",
      "line1": "123 Market Street",
      "line2": "Suite 400",
      "postal_code": "94105",
      "state": "CA"
    },
    "created_at": "2025-05-28T14:00:00Z",
    "email": "alice.johnson@example.com",
    "external_id": "ext_001",
    "full_name": "Alice Johnson",
    "id": "cus_b8d0fe7e-3a7f-4b5f-a68b-d31358b49c3f",
    "metadata": {
      "key": "value"
    },
    "phone": "+1-555-123-4567",
    "updated_at": "2025-05-28T14:05:00Z"
  },
  "cvc_check": {
    "result": {
      "cvc": "pass"
    }
  },
  "disputes": [
    {
      "disputed_at": "2026-08-01T10:15:00Z",
      "external_id": "dp_1Nx2yZAbCdEfGh",
      "id": "dsp_7c1a2b3c-4d5e-6f70-8a9b-0c1d2e3f4a5b",
      "reason": "FRAUDULENT",
      "stage": "DISPUTE",
      "status": "NEEDS_RESPONSE"
    }
  ],
  "id": "pay_e8a1b2c3-d4f5-6789-abcd-ef0123456789",
  "metadata": {
    "key": "value"
  },
  "payment_details": {
    "arn": "123453",
    "auth_code": "334385",
    "network_payment_id": "119676610486528",
    "processor_transaction_id": "pi_3RgN6TJVVBuowJOx0B4fpGWi"
  },
  "payment_method": {
    "details": {
      "bin": "411111",
      "bin_data": {
        "brand": "visa",
        "country": "AD",
        "currency_code": "<string>",
        "description": "Chase Sapphire Preferred",
        "funding": "debit",
        "issuer": "Chase Bank",
        "type": "consumer"
      },
      "exp_month": 12,
      "exp_year": 2028,
      "is_network_tokenized": true,
      "last4": "1111",
      "network_token": {
        "bin": "48953700",
        "last4": "0370",
        "exp_month": 5,
        "exp_year": 31,
        "status": "active",
        "last_synced_at": "2025-05-26T10:15:00Z"
      },
      "number": "4111111111111111"
    },
    "type": "CARD",
    "billing_address": {
      "city": "San Francisco",
      "country": "AD",
      "line1": "123 Market Street",
      "line2": "Suite 400",
      "postal_code": "94105",
      "state": "CA"
    },
    "card_updater": true,
    "fpan_out_of_sync": false,
    "status": "active"
  },
  "payment_status": "PENDING",
  "payment_token_type": "CARD_PAN",
  "payment_type": "MIT",
  "processor": {
    "description": "Stripe US",
    "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "processor_merchant_id": "12345678",
    "type": "STRIPE"
  },
  "refund": {
    "amount": 123,
    "amount_usd": 123,
    "created_at": "<string>",
    "processor_transaction_id": "<string>",
    "status": "PENDING",
    "updated_at": "<string>"
  },
  "refunded_amount": 0,
  "refund_reason": "fraud_prevention",
  "statement_descriptor": "MY COMPANY",
  "status_reason": {
    "status": "declined",
    "status_reason": {
      "advice_code": "do_not_try_again",
      "decline_code": "insufficient_funds",
      "message": "<string>"
    }
  },
  "subscription": {
    "created_at": "2025-05-26T10:00:00Z",
    "current_period_end": "<string>",
    "cancelled_at": "2026-06-10T14:32:08Z",
    "cancellation_details": {
      "reason": "fraud_prevention",
      "trigger_payment_id": "pay_e8a1b2c3-1d2e-3f4a-5b6c-7d8e9f0a1b2c"
    },
    "current_period_start": "<string>",
    "id": "sub_123e4567-e89b-12d3-a456-426614174000",
    "metadata": {
      "key": "value"
    },
    "next_billing_date": "2025-06-26T12:00:00Z",
    "past_due": {
      "attempt_count": 2,
      "max_attempts_count": 7
    },
    "plan": {
      "id": "price_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "interval": "days",
      "interval_count": 1,
      "name": "Pro Plan",
      "price": {
        "amount": 1999,
        "currency": "AED"
      },
      "tax": {
        "collect_tax": "<unknown>"
      },
      "trial_interval": "days",
      "trial_interval_count": 14,
      "trial_price": {
        "amount": 1999,
        "currency": "AED"
      },
      "type": "recurring"
    },
    "status": "trial",
    "updated_at": "2025-05-27T10:00:00Z"
  },
  "tax": {
    "amount_subtotal": 123,
    "amount_subtotal_usd": 123,
    "amount_tax": 123,
    "amount_tax_usd": 123,
    "behavior": "<unknown>",
    "calculation_id": "<string>",
    "error": {
      "code": "<unknown>",
      "message": "<string>"
    },
    "provider": {
      "id": "<string>",
      "type": "NUMERAL"
    },
    "status": "<unknown>",
    "transaction_id": "<string>"
  },
  "three_d_secure": {
    "authentication_flow": "<string>",
    "electronic_commerce_indicator": {
      "liability_shift": true,
      "result": "<string>",
      "value": "<string>"
    },
    "status": "action-required",
    "status_reason": "<string>",
    "transaction_id": "<string>",
    "version": "<string>"
  },
  "updated_at": "2025-05-26T10:15:00Z"
}

{
  "error": {
    "message": "some error message"
  }
}

{
  "error": {
    "message": "some error message"
  }
}

{
  "error": {
    "message": "some error message"
  }
}

Introduction

API Reference

Authorizations

Headers

Body

Response