cURL
curl --request POST \
--url https://api.tirdad.ai/v1/checkout/sessions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"customer_external_id": "<string>",
"cancel_url": "<string>",
"configuration": {
"add_addon_batch_params": [
{
"addons": [
{
"addon_id": "<string>",
"association_id": "<string>",
"coupons": [
{
"association_id": "<string>",
"coupon_id": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"price_id": "<string>",
"start_date": "2023-11-07T05:31:56Z"
}
],
"start_date": "2023-11-07T05:31:56Z"
}
],
"removes": [
{
"association_id": "<string>",
"effective_date": "2023-11-07T05:31:56Z",
"reason": "<string>"
}
],
"subscription_id": "<string>"
}
],
"add_addon_params": {
"addons": [
{
"addon_id": "<string>",
"association_id": "<string>",
"coupons": [
{
"association_id": "<string>",
"coupon_id": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"price_id": "<string>",
"start_date": "2023-11-07T05:31:56Z"
}
],
"start_date": "2023-11-07T05:31:56Z"
}
],
"removes": [
{
"association_id": "<string>",
"effective_date": "2023-11-07T05:31:56Z",
"reason": "<string>"
}
],
"subscription_id": "<string>"
},
"create_subscription_params": {
"currency": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"lookup_key": "<string>",
"metadata": {},
"plan_id": "<string>",
"start_date": "2023-11-07T05:31:56Z",
"subscription_id": "<string>"
},
"modify_subscription_params": {
"line_item_modifications": [
{
"amount": "<string>",
"coupons": [
{
"association_id": "<string>",
"coupon_id": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"price_id": "<string>",
"start_date": "2023-11-07T05:31:56Z"
}
],
"effective_date": "2023-11-07T05:31:56Z",
"line_item_id": "<string>",
"quantity": "<string>"
}
],
"subscription_id": "<string>",
"trial_end_at": "2023-11-07T05:31:56Z"
}
},
"entity_creation_options": {
"entity_creation_conflict_policies": {}
},
"failure_url": "<string>",
"idempotency_key": "<string>",
"metadata": {},
"payment_provider_config": {
"customer_not_present": true,
"max_mandate_limit": "<string>"
},
"success_url": "<string>"
}
'from tirdad_sdk import Tirdad
with Tirdad(
api_key_auth="<YOUR_API_KEY_HERE>",
) as f_client:
res = f_client.checkout.create_checkout_session(action="pay_invoice", customer_external_id="<id>", payment_provider="razorpay")
# Handle response
print(res)import { Tirdad } from "@tirdad/sdk";
const tirdad = new Tirdad({
apiKeyAuth: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await tirdad.checkout.createCheckoutSession({
action: "pay_invoice",
customerExternalId: "<id>",
paymentProvider: "razorpay",
});
console.log(result);
}
run();package main
import(
"context"
tirdad "github.com/tirdad-billing/go-sdk/v2"
"github.com/tirdad-billing/go-sdk/v2/models/types"
"log"
)
func main() {
ctx := context.Background()
s := tirdad.New(
tirdad.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Checkout.CreateCheckoutSession(ctx, types.CreateCheckoutSessionRequest{
Action: types.CheckoutActionPayInvoice,
CustomerExternalID: "<id>",
PaymentProvider: types.CheckoutPaymentProviderRazorpay,
})
if err != nil {
log.Fatal(err)
}
if res.CheckoutSessionResponse != nil {
// handle response
}
}{
"action": "create_subscription",
"cancel_url": "<string>",
"cancelled_at": "2023-11-07T05:31:56Z",
"checkout_invoice_id": "<string>",
"checkout_payment_id": "<string>",
"checkout_status": "initiated",
"completed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"customer_id": "<string>",
"entity_creation_result": {
"entity_id": "<string>",
"status": "created"
},
"expires_at": "2023-11-07T05:31:56Z",
"failure_reason": "<string>",
"failure_url": "<string>",
"id": "<string>",
"idempotency_key": "<string>",
"metadata": {},
"next_poll_after_ms": 123,
"payment": {
"gateway": "<string>",
"id": "<string>",
"status": "INITIATED"
},
"payment_action": {
"type": "checkout_url",
"url": "<string>"
},
"payment_provider": "razorpay",
"stale": true,
"success_url": "<string>",
"terminal": true,
"updated_at": "2023-11-07T05:31:56Z"
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}Checkout
Create checkout session
POST
/
checkout
/
sessions
cURL
curl --request POST \
--url https://api.tirdad.ai/v1/checkout/sessions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"customer_external_id": "<string>",
"cancel_url": "<string>",
"configuration": {
"add_addon_batch_params": [
{
"addons": [
{
"addon_id": "<string>",
"association_id": "<string>",
"coupons": [
{
"association_id": "<string>",
"coupon_id": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"price_id": "<string>",
"start_date": "2023-11-07T05:31:56Z"
}
],
"start_date": "2023-11-07T05:31:56Z"
}
],
"removes": [
{
"association_id": "<string>",
"effective_date": "2023-11-07T05:31:56Z",
"reason": "<string>"
}
],
"subscription_id": "<string>"
}
],
"add_addon_params": {
"addons": [
{
"addon_id": "<string>",
"association_id": "<string>",
"coupons": [
{
"association_id": "<string>",
"coupon_id": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"price_id": "<string>",
"start_date": "2023-11-07T05:31:56Z"
}
],
"start_date": "2023-11-07T05:31:56Z"
}
],
"removes": [
{
"association_id": "<string>",
"effective_date": "2023-11-07T05:31:56Z",
"reason": "<string>"
}
],
"subscription_id": "<string>"
},
"create_subscription_params": {
"currency": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"lookup_key": "<string>",
"metadata": {},
"plan_id": "<string>",
"start_date": "2023-11-07T05:31:56Z",
"subscription_id": "<string>"
},
"modify_subscription_params": {
"line_item_modifications": [
{
"amount": "<string>",
"coupons": [
{
"association_id": "<string>",
"coupon_id": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"price_id": "<string>",
"start_date": "2023-11-07T05:31:56Z"
}
],
"effective_date": "2023-11-07T05:31:56Z",
"line_item_id": "<string>",
"quantity": "<string>"
}
],
"subscription_id": "<string>",
"trial_end_at": "2023-11-07T05:31:56Z"
}
},
"entity_creation_options": {
"entity_creation_conflict_policies": {}
},
"failure_url": "<string>",
"idempotency_key": "<string>",
"metadata": {},
"payment_provider_config": {
"customer_not_present": true,
"max_mandate_limit": "<string>"
},
"success_url": "<string>"
}
'from tirdad_sdk import Tirdad
with Tirdad(
api_key_auth="<YOUR_API_KEY_HERE>",
) as f_client:
res = f_client.checkout.create_checkout_session(action="pay_invoice", customer_external_id="<id>", payment_provider="razorpay")
# Handle response
print(res)import { Tirdad } from "@tirdad/sdk";
const tirdad = new Tirdad({
apiKeyAuth: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await tirdad.checkout.createCheckoutSession({
action: "pay_invoice",
customerExternalId: "<id>",
paymentProvider: "razorpay",
});
console.log(result);
}
run();package main
import(
"context"
tirdad "github.com/tirdad-billing/go-sdk/v2"
"github.com/tirdad-billing/go-sdk/v2/models/types"
"log"
)
func main() {
ctx := context.Background()
s := tirdad.New(
tirdad.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Checkout.CreateCheckoutSession(ctx, types.CreateCheckoutSessionRequest{
Action: types.CheckoutActionPayInvoice,
CustomerExternalID: "<id>",
PaymentProvider: types.CheckoutPaymentProviderRazorpay,
})
if err != nil {
log.Fatal(err)
}
if res.CheckoutSessionResponse != nil {
// handle response
}
}{
"action": "create_subscription",
"cancel_url": "<string>",
"cancelled_at": "2023-11-07T05:31:56Z",
"checkout_invoice_id": "<string>",
"checkout_payment_id": "<string>",
"checkout_status": "initiated",
"completed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"customer_id": "<string>",
"entity_creation_result": {
"entity_id": "<string>",
"status": "created"
},
"expires_at": "2023-11-07T05:31:56Z",
"failure_reason": "<string>",
"failure_url": "<string>",
"id": "<string>",
"idempotency_key": "<string>",
"metadata": {},
"next_poll_after_ms": 123,
"payment": {
"gateway": "<string>",
"id": "<string>",
"status": "INITIATED"
},
"payment_action": {
"type": "checkout_url",
"url": "<string>"
},
"payment_provider": "razorpay",
"stale": true,
"success_url": "<string>",
"terminal": true,
"updated_at": "2023-11-07T05:31:56Z"
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}Body
application/json
Checkout session to create
Response
Created