curl --request POST \
--url https://us.api.flexprice.io/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_params": {
"addons": [
{
"addon_id": "<string>",
"association_id": "<string>",
"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": [
{
"effective_date": "2023-11-07T05:31:56Z",
"line_item_id": "<string>",
"quantity": "<string>"
}
],
"subscription_id": "<string>"
}
},
"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>"
}
'import requests
url = "https://us.api.flexprice.io/v1/checkout/sessions"
payload = {
"customer_external_id": "<string>",
"cancel_url": "<string>",
"configuration": {
"add_addon_params": {
"addons": [
{
"addon_id": "<string>",
"association_id": "<string>",
"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": [
{
"effective_date": "2023-11-07T05:31:56Z",
"line_item_id": "<string>",
"quantity": "<string>"
}
],
"subscription_id": "<string>"
}
},
"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>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customer_external_id: '<string>',
cancel_url: '<string>',
configuration: {
add_addon_params: {
addons: [
{
addon_id: '<string>',
association_id: '<string>',
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: [
{
effective_date: '2023-11-07T05:31:56Z',
line_item_id: '<string>',
quantity: '<string>'
}
],
subscription_id: '<string>'
}
},
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>'
})
};
fetch('https://us.api.flexprice.io/v1/checkout/sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://us.api.flexprice.io/v1/checkout/sessions",
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_external_id' => '<string>',
'cancel_url' => '<string>',
'configuration' => [
'add_addon_params' => [
'addons' => [
[
'addon_id' => '<string>',
'association_id' => '<string>',
'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' => [
[
'effective_date' => '2023-11-07T05:31:56Z',
'line_item_id' => '<string>',
'quantity' => '<string>'
]
],
'subscription_id' => '<string>'
]
],
'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>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://us.api.flexprice.io/v1/checkout/sessions"
payload := strings.NewReader("{\n \"customer_external_id\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"configuration\": {\n \"add_addon_params\": {\n \"addons\": [\n {\n \"addon_id\": \"<string>\",\n \"association_id\": \"<string>\",\n \"start_date\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"removes\": [\n {\n \"association_id\": \"<string>\",\n \"effective_date\": \"2023-11-07T05:31:56Z\",\n \"reason\": \"<string>\"\n }\n ],\n \"subscription_id\": \"<string>\"\n },\n \"create_subscription_params\": {\n \"currency\": \"<string>\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"lookup_key\": \"<string>\",\n \"metadata\": {},\n \"plan_id\": \"<string>\",\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"subscription_id\": \"<string>\"\n },\n \"modify_subscription_params\": {\n \"line_item_modifications\": [\n {\n \"effective_date\": \"2023-11-07T05:31:56Z\",\n \"line_item_id\": \"<string>\",\n \"quantity\": \"<string>\"\n }\n ],\n \"subscription_id\": \"<string>\"\n }\n },\n \"entity_creation_options\": {\n \"entity_creation_conflict_policies\": {}\n },\n \"failure_url\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"metadata\": {},\n \"payment_provider_config\": {\n \"customer_not_present\": true,\n \"max_mandate_limit\": \"<string>\"\n },\n \"success_url\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://us.api.flexprice.io/v1/checkout/sessions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customer_external_id\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"configuration\": {\n \"add_addon_params\": {\n \"addons\": [\n {\n \"addon_id\": \"<string>\",\n \"association_id\": \"<string>\",\n \"start_date\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"removes\": [\n {\n \"association_id\": \"<string>\",\n \"effective_date\": \"2023-11-07T05:31:56Z\",\n \"reason\": \"<string>\"\n }\n ],\n \"subscription_id\": \"<string>\"\n },\n \"create_subscription_params\": {\n \"currency\": \"<string>\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"lookup_key\": \"<string>\",\n \"metadata\": {},\n \"plan_id\": \"<string>\",\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"subscription_id\": \"<string>\"\n },\n \"modify_subscription_params\": {\n \"line_item_modifications\": [\n {\n \"effective_date\": \"2023-11-07T05:31:56Z\",\n \"line_item_id\": \"<string>\",\n \"quantity\": \"<string>\"\n }\n ],\n \"subscription_id\": \"<string>\"\n }\n },\n \"entity_creation_options\": {\n \"entity_creation_conflict_policies\": {}\n },\n \"failure_url\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"metadata\": {},\n \"payment_provider_config\": {\n \"customer_not_present\": true,\n \"max_mandate_limit\": \"<string>\"\n },\n \"success_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.api.flexprice.io/v1/checkout/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer_external_id\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"configuration\": {\n \"add_addon_params\": {\n \"addons\": [\n {\n \"addon_id\": \"<string>\",\n \"association_id\": \"<string>\",\n \"start_date\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"removes\": [\n {\n \"association_id\": \"<string>\",\n \"effective_date\": \"2023-11-07T05:31:56Z\",\n \"reason\": \"<string>\"\n }\n ],\n \"subscription_id\": \"<string>\"\n },\n \"create_subscription_params\": {\n \"currency\": \"<string>\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"lookup_key\": \"<string>\",\n \"metadata\": {},\n \"plan_id\": \"<string>\",\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"subscription_id\": \"<string>\"\n },\n \"modify_subscription_params\": {\n \"line_item_modifications\": [\n {\n \"effective_date\": \"2023-11-07T05:31:56Z\",\n \"line_item_id\": \"<string>\",\n \"quantity\": \"<string>\"\n }\n ],\n \"subscription_id\": \"<string>\"\n }\n },\n \"entity_creation_options\": {\n \"entity_creation_conflict_policies\": {}\n },\n \"failure_url\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"metadata\": {},\n \"payment_provider_config\": {\n \"customer_not_present\": true,\n \"max_mandate_limit\": \"<string>\"\n },\n \"success_url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>"
}Create checkout session
curl --request POST \
--url https://us.api.flexprice.io/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_params": {
"addons": [
{
"addon_id": "<string>",
"association_id": "<string>",
"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": [
{
"effective_date": "2023-11-07T05:31:56Z",
"line_item_id": "<string>",
"quantity": "<string>"
}
],
"subscription_id": "<string>"
}
},
"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>"
}
'import requests
url = "https://us.api.flexprice.io/v1/checkout/sessions"
payload = {
"customer_external_id": "<string>",
"cancel_url": "<string>",
"configuration": {
"add_addon_params": {
"addons": [
{
"addon_id": "<string>",
"association_id": "<string>",
"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": [
{
"effective_date": "2023-11-07T05:31:56Z",
"line_item_id": "<string>",
"quantity": "<string>"
}
],
"subscription_id": "<string>"
}
},
"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>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customer_external_id: '<string>',
cancel_url: '<string>',
configuration: {
add_addon_params: {
addons: [
{
addon_id: '<string>',
association_id: '<string>',
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: [
{
effective_date: '2023-11-07T05:31:56Z',
line_item_id: '<string>',
quantity: '<string>'
}
],
subscription_id: '<string>'
}
},
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>'
})
};
fetch('https://us.api.flexprice.io/v1/checkout/sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://us.api.flexprice.io/v1/checkout/sessions",
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_external_id' => '<string>',
'cancel_url' => '<string>',
'configuration' => [
'add_addon_params' => [
'addons' => [
[
'addon_id' => '<string>',
'association_id' => '<string>',
'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' => [
[
'effective_date' => '2023-11-07T05:31:56Z',
'line_item_id' => '<string>',
'quantity' => '<string>'
]
],
'subscription_id' => '<string>'
]
],
'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>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://us.api.flexprice.io/v1/checkout/sessions"
payload := strings.NewReader("{\n \"customer_external_id\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"configuration\": {\n \"add_addon_params\": {\n \"addons\": [\n {\n \"addon_id\": \"<string>\",\n \"association_id\": \"<string>\",\n \"start_date\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"removes\": [\n {\n \"association_id\": \"<string>\",\n \"effective_date\": \"2023-11-07T05:31:56Z\",\n \"reason\": \"<string>\"\n }\n ],\n \"subscription_id\": \"<string>\"\n },\n \"create_subscription_params\": {\n \"currency\": \"<string>\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"lookup_key\": \"<string>\",\n \"metadata\": {},\n \"plan_id\": \"<string>\",\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"subscription_id\": \"<string>\"\n },\n \"modify_subscription_params\": {\n \"line_item_modifications\": [\n {\n \"effective_date\": \"2023-11-07T05:31:56Z\",\n \"line_item_id\": \"<string>\",\n \"quantity\": \"<string>\"\n }\n ],\n \"subscription_id\": \"<string>\"\n }\n },\n \"entity_creation_options\": {\n \"entity_creation_conflict_policies\": {}\n },\n \"failure_url\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"metadata\": {},\n \"payment_provider_config\": {\n \"customer_not_present\": true,\n \"max_mandate_limit\": \"<string>\"\n },\n \"success_url\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://us.api.flexprice.io/v1/checkout/sessions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customer_external_id\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"configuration\": {\n \"add_addon_params\": {\n \"addons\": [\n {\n \"addon_id\": \"<string>\",\n \"association_id\": \"<string>\",\n \"start_date\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"removes\": [\n {\n \"association_id\": \"<string>\",\n \"effective_date\": \"2023-11-07T05:31:56Z\",\n \"reason\": \"<string>\"\n }\n ],\n \"subscription_id\": \"<string>\"\n },\n \"create_subscription_params\": {\n \"currency\": \"<string>\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"lookup_key\": \"<string>\",\n \"metadata\": {},\n \"plan_id\": \"<string>\",\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"subscription_id\": \"<string>\"\n },\n \"modify_subscription_params\": {\n \"line_item_modifications\": [\n {\n \"effective_date\": \"2023-11-07T05:31:56Z\",\n \"line_item_id\": \"<string>\",\n \"quantity\": \"<string>\"\n }\n ],\n \"subscription_id\": \"<string>\"\n }\n },\n \"entity_creation_options\": {\n \"entity_creation_conflict_policies\": {}\n },\n \"failure_url\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"metadata\": {},\n \"payment_provider_config\": {\n \"customer_not_present\": true,\n \"max_mandate_limit\": \"<string>\"\n },\n \"success_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.api.flexprice.io/v1/checkout/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer_external_id\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"configuration\": {\n \"add_addon_params\": {\n \"addons\": [\n {\n \"addon_id\": \"<string>\",\n \"association_id\": \"<string>\",\n \"start_date\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"removes\": [\n {\n \"association_id\": \"<string>\",\n \"effective_date\": \"2023-11-07T05:31:56Z\",\n \"reason\": \"<string>\"\n }\n ],\n \"subscription_id\": \"<string>\"\n },\n \"create_subscription_params\": {\n \"currency\": \"<string>\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"lookup_key\": \"<string>\",\n \"metadata\": {},\n \"plan_id\": \"<string>\",\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"subscription_id\": \"<string>\"\n },\n \"modify_subscription_params\": {\n \"line_item_modifications\": [\n {\n \"effective_date\": \"2023-11-07T05:31:56Z\",\n \"line_item_id\": \"<string>\",\n \"quantity\": \"<string>\"\n }\n ],\n \"subscription_id\": \"<string>\"\n }\n },\n \"entity_creation_options\": {\n \"entity_creation_conflict_policies\": {}\n },\n \"failure_url\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"metadata\": {},\n \"payment_provider_config\": {\n \"customer_not_present\": true,\n \"max_mandate_limit\": \"<string>\"\n },\n \"success_url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>"
}Authorizations
Enter your API key in the format x-api-key <api-key>*
Body
Checkout session to create
create_subscription, modify_subscription, wallet_topup, add_addon, pay_invoice razorpay, chargebee Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Created
create_subscription, modify_subscription, wallet_topup, add_addon, pay_invoice initiated, pending, completed, failed, expired Show child attributes
Show child attributes
Show child attributes
Show child attributes
NextPollAfterMs is how long a client should wait before reading again. Zero means stop — either the session is terminal, or this response did not come from a polling read.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
razorpay, chargebee Stale reports that this response is stored state that was not checked against the payment provider on this request — the read was debounced, or the gateway did not answer. A UI should say "still checking" rather than presenting a stale answer as fact.
Terminal reports whether the session has finished. Clients poll until this is true rather than hardcoding the status set, which would go stale if a status is ever added.

