Fire a due subscription renewal cycle
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/commerce/subscriptions/renew \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"subscription": {
"id": "<string>",
"cartId": "<string>",
"principalId": "<string>",
"mandateId": "<string>",
"items": [
{
"productRetailerId": "<string>",
"name": "<string>",
"quantity": 123,
"unitPrice": 123,
"currency": "<string>"
}
],
"currency": "<string>",
"amount": 123,
"cyclesCompleted": 123,
"nextChargeAt": 123,
"lastRenewalAt": 123,
"lastRenewalReference": "<string>",
"createdAt": 123,
"updatedAt": 123,
"pausedAt": 123,
"canceledAt": 123
},
"mandate": {
"id": "<string>",
"agentId": "<string>",
"principalId": "<string>",
"maxPerTransaction": 123,
"totalCap": 123,
"currency": "<string>",
"allowedMerchants": [
"<string>"
],
"allowedCategories": [
"<string>"
],
"spent": 123,
"authorizationCount": 123,
"consentDigest": "<string>",
"expiresAt": 123,
"createdAt": 123,
"updatedAt": 123,
"revokedAt": 123
},
"config": {
"hostedBaseUrl": "<string>",
"merchant": "<string>",
"category": "<string>",
"buyerCountry": "<string>",
"enabledNativeRails": []
}
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/commerce/subscriptions/renew"
payload = {
"subscription": {
"id": "<string>",
"cartId": "<string>",
"principalId": "<string>",
"mandateId": "<string>",
"items": [
{
"productRetailerId": "<string>",
"name": "<string>",
"quantity": 123,
"unitPrice": 123,
"currency": "<string>"
}
],
"currency": "<string>",
"amount": 123,
"cyclesCompleted": 123,
"nextChargeAt": 123,
"lastRenewalAt": 123,
"lastRenewalReference": "<string>",
"createdAt": 123,
"updatedAt": 123,
"pausedAt": 123,
"canceledAt": 123
},
"mandate": {
"id": "<string>",
"agentId": "<string>",
"principalId": "<string>",
"maxPerTransaction": 123,
"totalCap": 123,
"currency": "<string>",
"allowedMerchants": ["<string>"],
"allowedCategories": ["<string>"],
"spent": 123,
"authorizationCount": 123,
"consentDigest": "<string>",
"expiresAt": 123,
"createdAt": 123,
"updatedAt": 123,
"revokedAt": 123
},
"config": {
"hostedBaseUrl": "<string>",
"merchant": "<string>",
"category": "<string>",
"buyerCountry": "<string>",
"enabledNativeRails": []
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
subscription: {
id: '<string>',
cartId: '<string>',
principalId: '<string>',
mandateId: '<string>',
items: [
{
productRetailerId: '<string>',
name: '<string>',
quantity: 123,
unitPrice: 123,
currency: '<string>'
}
],
currency: '<string>',
amount: 123,
cyclesCompleted: 123,
nextChargeAt: 123,
lastRenewalAt: 123,
lastRenewalReference: '<string>',
createdAt: 123,
updatedAt: 123,
pausedAt: 123,
canceledAt: 123
},
mandate: {
id: '<string>',
agentId: '<string>',
principalId: '<string>',
maxPerTransaction: 123,
totalCap: 123,
currency: '<string>',
allowedMerchants: ['<string>'],
allowedCategories: ['<string>'],
spent: 123,
authorizationCount: 123,
consentDigest: '<string>',
expiresAt: 123,
createdAt: 123,
updatedAt: 123,
revokedAt: 123
},
config: {
hostedBaseUrl: '<string>',
merchant: '<string>',
category: '<string>',
buyerCountry: '<string>',
enabledNativeRails: []
}
})
};
fetch('https://api.orbit.devotel.io/api/v1/commerce/subscriptions/renew', 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://api.orbit.devotel.io/api/v1/commerce/subscriptions/renew",
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([
'subscription' => [
'id' => '<string>',
'cartId' => '<string>',
'principalId' => '<string>',
'mandateId' => '<string>',
'items' => [
[
'productRetailerId' => '<string>',
'name' => '<string>',
'quantity' => 123,
'unitPrice' => 123,
'currency' => '<string>'
]
],
'currency' => '<string>',
'amount' => 123,
'cyclesCompleted' => 123,
'nextChargeAt' => 123,
'lastRenewalAt' => 123,
'lastRenewalReference' => '<string>',
'createdAt' => 123,
'updatedAt' => 123,
'pausedAt' => 123,
'canceledAt' => 123
],
'mandate' => [
'id' => '<string>',
'agentId' => '<string>',
'principalId' => '<string>',
'maxPerTransaction' => 123,
'totalCap' => 123,
'currency' => '<string>',
'allowedMerchants' => [
'<string>'
],
'allowedCategories' => [
'<string>'
],
'spent' => 123,
'authorizationCount' => 123,
'consentDigest' => '<string>',
'expiresAt' => 123,
'createdAt' => 123,
'updatedAt' => 123,
'revokedAt' => 123
],
'config' => [
'hostedBaseUrl' => '<string>',
'merchant' => '<string>',
'category' => '<string>',
'buyerCountry' => '<string>',
'enabledNativeRails' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.orbit.devotel.io/api/v1/commerce/subscriptions/renew"
payload := strings.NewReader("{\n \"subscription\": {\n \"id\": \"<string>\",\n \"cartId\": \"<string>\",\n \"principalId\": \"<string>\",\n \"mandateId\": \"<string>\",\n \"items\": [\n {\n \"productRetailerId\": \"<string>\",\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"currency\": \"<string>\"\n }\n ],\n \"currency\": \"<string>\",\n \"amount\": 123,\n \"cyclesCompleted\": 123,\n \"nextChargeAt\": 123,\n \"lastRenewalAt\": 123,\n \"lastRenewalReference\": \"<string>\",\n \"createdAt\": 123,\n \"updatedAt\": 123,\n \"pausedAt\": 123,\n \"canceledAt\": 123\n },\n \"mandate\": {\n \"id\": \"<string>\",\n \"agentId\": \"<string>\",\n \"principalId\": \"<string>\",\n \"maxPerTransaction\": 123,\n \"totalCap\": 123,\n \"currency\": \"<string>\",\n \"allowedMerchants\": [\n \"<string>\"\n ],\n \"allowedCategories\": [\n \"<string>\"\n ],\n \"spent\": 123,\n \"authorizationCount\": 123,\n \"consentDigest\": \"<string>\",\n \"expiresAt\": 123,\n \"createdAt\": 123,\n \"updatedAt\": 123,\n \"revokedAt\": 123\n },\n \"config\": {\n \"hostedBaseUrl\": \"<string>\",\n \"merchant\": \"<string>\",\n \"category\": \"<string>\",\n \"buyerCountry\": \"<string>\",\n \"enabledNativeRails\": []\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.orbit.devotel.io/api/v1/commerce/subscriptions/renew")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"subscription\": {\n \"id\": \"<string>\",\n \"cartId\": \"<string>\",\n \"principalId\": \"<string>\",\n \"mandateId\": \"<string>\",\n \"items\": [\n {\n \"productRetailerId\": \"<string>\",\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"currency\": \"<string>\"\n }\n ],\n \"currency\": \"<string>\",\n \"amount\": 123,\n \"cyclesCompleted\": 123,\n \"nextChargeAt\": 123,\n \"lastRenewalAt\": 123,\n \"lastRenewalReference\": \"<string>\",\n \"createdAt\": 123,\n \"updatedAt\": 123,\n \"pausedAt\": 123,\n \"canceledAt\": 123\n },\n \"mandate\": {\n \"id\": \"<string>\",\n \"agentId\": \"<string>\",\n \"principalId\": \"<string>\",\n \"maxPerTransaction\": 123,\n \"totalCap\": 123,\n \"currency\": \"<string>\",\n \"allowedMerchants\": [\n \"<string>\"\n ],\n \"allowedCategories\": [\n \"<string>\"\n ],\n \"spent\": 123,\n \"authorizationCount\": 123,\n \"consentDigest\": \"<string>\",\n \"expiresAt\": 123,\n \"createdAt\": 123,\n \"updatedAt\": 123,\n \"revokedAt\": 123\n },\n \"config\": {\n \"hostedBaseUrl\": \"<string>\",\n \"merchant\": \"<string>\",\n \"category\": \"<string>\",\n \"buyerCountry\": \"<string>\",\n \"enabledNativeRails\": []\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/commerce/subscriptions/renew")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"subscription\": {\n \"id\": \"<string>\",\n \"cartId\": \"<string>\",\n \"principalId\": \"<string>\",\n \"mandateId\": \"<string>\",\n \"items\": [\n {\n \"productRetailerId\": \"<string>\",\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"currency\": \"<string>\"\n }\n ],\n \"currency\": \"<string>\",\n \"amount\": 123,\n \"cyclesCompleted\": 123,\n \"nextChargeAt\": 123,\n \"lastRenewalAt\": 123,\n \"lastRenewalReference\": \"<string>\",\n \"createdAt\": 123,\n \"updatedAt\": 123,\n \"pausedAt\": 123,\n \"canceledAt\": 123\n },\n \"mandate\": {\n \"id\": \"<string>\",\n \"agentId\": \"<string>\",\n \"principalId\": \"<string>\",\n \"maxPerTransaction\": 123,\n \"totalCap\": 123,\n \"currency\": \"<string>\",\n \"allowedMerchants\": [\n \"<string>\"\n ],\n \"allowedCategories\": [\n \"<string>\"\n ],\n \"spent\": 123,\n \"authorizationCount\": 123,\n \"consentDigest\": \"<string>\",\n \"expiresAt\": 123,\n \"createdAt\": 123,\n \"updatedAt\": 123,\n \"revokedAt\": 123\n },\n \"config\": {\n \"hostedBaseUrl\": \"<string>\",\n \"merchant\": \"<string>\",\n \"category\": \"<string>\",\n \"buyerCountry\": \"<string>\",\n \"enabledNativeRails\": []\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"subscription": {
"id": "<string>",
"cartId": "<string>",
"principalId": "<string>",
"mandateId": "<string>",
"channel": "whatsapp",
"items": [
{
"productRetailerId": "<string>",
"name": "<string>",
"quantity": 123,
"unitPrice": 123,
"currency": "<string>"
}
],
"currency": "<string>",
"amount": 123,
"interval": "weekly",
"status": "active",
"cyclesCompleted": 123,
"nextChargeAt": 123,
"lastRenewalAt": 123,
"lastRenewalReference": "<string>",
"createdAt": 123,
"updatedAt": 123,
"pausedAt": 123,
"canceledAt": 123
},
"mandate": {
"id": "<string>",
"agentId": "<string>",
"principalId": "<string>",
"maxPerTransaction": 123,
"totalCap": 123,
"currency": "<string>",
"allowedMerchants": [
"<string>"
],
"allowedCategories": [
"<string>"
],
"spent": 123,
"authorizationCount": 123,
"status": "active",
"consentDigest": "<string>",
"expiresAt": 123,
"createdAt": 123,
"updatedAt": 123,
"revokedAt": 123
},
"checkout": {},
"webhookEvent": {
"event": "<string>",
"subscriptionId": "<string>",
"cycleNumber": 123,
"amount": 123,
"currency": "<string>",
"channel": "whatsapp",
"chargeReference": "<string>",
"nextChargeAt": 123,
"occurredAt": 123
}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Commerce
Fire a due subscription renewal cycle
Authorize+commit the cycle’s charge against the stored payment mandate (no new consent collected), mint the reorder’s RCS/WhatsApp checkout, and advance the schedule. Rejected with VALIDATION_ERROR when the subscription isn’t active/due, or when the mandate declines the charge.
POST
/
api
/
v1
/
commerce
/
subscriptions
/
renew
Fire a due subscription renewal cycle
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/commerce/subscriptions/renew \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"subscription": {
"id": "<string>",
"cartId": "<string>",
"principalId": "<string>",
"mandateId": "<string>",
"items": [
{
"productRetailerId": "<string>",
"name": "<string>",
"quantity": 123,
"unitPrice": 123,
"currency": "<string>"
}
],
"currency": "<string>",
"amount": 123,
"cyclesCompleted": 123,
"nextChargeAt": 123,
"lastRenewalAt": 123,
"lastRenewalReference": "<string>",
"createdAt": 123,
"updatedAt": 123,
"pausedAt": 123,
"canceledAt": 123
},
"mandate": {
"id": "<string>",
"agentId": "<string>",
"principalId": "<string>",
"maxPerTransaction": 123,
"totalCap": 123,
"currency": "<string>",
"allowedMerchants": [
"<string>"
],
"allowedCategories": [
"<string>"
],
"spent": 123,
"authorizationCount": 123,
"consentDigest": "<string>",
"expiresAt": 123,
"createdAt": 123,
"updatedAt": 123,
"revokedAt": 123
},
"config": {
"hostedBaseUrl": "<string>",
"merchant": "<string>",
"category": "<string>",
"buyerCountry": "<string>",
"enabledNativeRails": []
}
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/commerce/subscriptions/renew"
payload = {
"subscription": {
"id": "<string>",
"cartId": "<string>",
"principalId": "<string>",
"mandateId": "<string>",
"items": [
{
"productRetailerId": "<string>",
"name": "<string>",
"quantity": 123,
"unitPrice": 123,
"currency": "<string>"
}
],
"currency": "<string>",
"amount": 123,
"cyclesCompleted": 123,
"nextChargeAt": 123,
"lastRenewalAt": 123,
"lastRenewalReference": "<string>",
"createdAt": 123,
"updatedAt": 123,
"pausedAt": 123,
"canceledAt": 123
},
"mandate": {
"id": "<string>",
"agentId": "<string>",
"principalId": "<string>",
"maxPerTransaction": 123,
"totalCap": 123,
"currency": "<string>",
"allowedMerchants": ["<string>"],
"allowedCategories": ["<string>"],
"spent": 123,
"authorizationCount": 123,
"consentDigest": "<string>",
"expiresAt": 123,
"createdAt": 123,
"updatedAt": 123,
"revokedAt": 123
},
"config": {
"hostedBaseUrl": "<string>",
"merchant": "<string>",
"category": "<string>",
"buyerCountry": "<string>",
"enabledNativeRails": []
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
subscription: {
id: '<string>',
cartId: '<string>',
principalId: '<string>',
mandateId: '<string>',
items: [
{
productRetailerId: '<string>',
name: '<string>',
quantity: 123,
unitPrice: 123,
currency: '<string>'
}
],
currency: '<string>',
amount: 123,
cyclesCompleted: 123,
nextChargeAt: 123,
lastRenewalAt: 123,
lastRenewalReference: '<string>',
createdAt: 123,
updatedAt: 123,
pausedAt: 123,
canceledAt: 123
},
mandate: {
id: '<string>',
agentId: '<string>',
principalId: '<string>',
maxPerTransaction: 123,
totalCap: 123,
currency: '<string>',
allowedMerchants: ['<string>'],
allowedCategories: ['<string>'],
spent: 123,
authorizationCount: 123,
consentDigest: '<string>',
expiresAt: 123,
createdAt: 123,
updatedAt: 123,
revokedAt: 123
},
config: {
hostedBaseUrl: '<string>',
merchant: '<string>',
category: '<string>',
buyerCountry: '<string>',
enabledNativeRails: []
}
})
};
fetch('https://api.orbit.devotel.io/api/v1/commerce/subscriptions/renew', 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://api.orbit.devotel.io/api/v1/commerce/subscriptions/renew",
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([
'subscription' => [
'id' => '<string>',
'cartId' => '<string>',
'principalId' => '<string>',
'mandateId' => '<string>',
'items' => [
[
'productRetailerId' => '<string>',
'name' => '<string>',
'quantity' => 123,
'unitPrice' => 123,
'currency' => '<string>'
]
],
'currency' => '<string>',
'amount' => 123,
'cyclesCompleted' => 123,
'nextChargeAt' => 123,
'lastRenewalAt' => 123,
'lastRenewalReference' => '<string>',
'createdAt' => 123,
'updatedAt' => 123,
'pausedAt' => 123,
'canceledAt' => 123
],
'mandate' => [
'id' => '<string>',
'agentId' => '<string>',
'principalId' => '<string>',
'maxPerTransaction' => 123,
'totalCap' => 123,
'currency' => '<string>',
'allowedMerchants' => [
'<string>'
],
'allowedCategories' => [
'<string>'
],
'spent' => 123,
'authorizationCount' => 123,
'consentDigest' => '<string>',
'expiresAt' => 123,
'createdAt' => 123,
'updatedAt' => 123,
'revokedAt' => 123
],
'config' => [
'hostedBaseUrl' => '<string>',
'merchant' => '<string>',
'category' => '<string>',
'buyerCountry' => '<string>',
'enabledNativeRails' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.orbit.devotel.io/api/v1/commerce/subscriptions/renew"
payload := strings.NewReader("{\n \"subscription\": {\n \"id\": \"<string>\",\n \"cartId\": \"<string>\",\n \"principalId\": \"<string>\",\n \"mandateId\": \"<string>\",\n \"items\": [\n {\n \"productRetailerId\": \"<string>\",\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"currency\": \"<string>\"\n }\n ],\n \"currency\": \"<string>\",\n \"amount\": 123,\n \"cyclesCompleted\": 123,\n \"nextChargeAt\": 123,\n \"lastRenewalAt\": 123,\n \"lastRenewalReference\": \"<string>\",\n \"createdAt\": 123,\n \"updatedAt\": 123,\n \"pausedAt\": 123,\n \"canceledAt\": 123\n },\n \"mandate\": {\n \"id\": \"<string>\",\n \"agentId\": \"<string>\",\n \"principalId\": \"<string>\",\n \"maxPerTransaction\": 123,\n \"totalCap\": 123,\n \"currency\": \"<string>\",\n \"allowedMerchants\": [\n \"<string>\"\n ],\n \"allowedCategories\": [\n \"<string>\"\n ],\n \"spent\": 123,\n \"authorizationCount\": 123,\n \"consentDigest\": \"<string>\",\n \"expiresAt\": 123,\n \"createdAt\": 123,\n \"updatedAt\": 123,\n \"revokedAt\": 123\n },\n \"config\": {\n \"hostedBaseUrl\": \"<string>\",\n \"merchant\": \"<string>\",\n \"category\": \"<string>\",\n \"buyerCountry\": \"<string>\",\n \"enabledNativeRails\": []\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.orbit.devotel.io/api/v1/commerce/subscriptions/renew")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"subscription\": {\n \"id\": \"<string>\",\n \"cartId\": \"<string>\",\n \"principalId\": \"<string>\",\n \"mandateId\": \"<string>\",\n \"items\": [\n {\n \"productRetailerId\": \"<string>\",\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"currency\": \"<string>\"\n }\n ],\n \"currency\": \"<string>\",\n \"amount\": 123,\n \"cyclesCompleted\": 123,\n \"nextChargeAt\": 123,\n \"lastRenewalAt\": 123,\n \"lastRenewalReference\": \"<string>\",\n \"createdAt\": 123,\n \"updatedAt\": 123,\n \"pausedAt\": 123,\n \"canceledAt\": 123\n },\n \"mandate\": {\n \"id\": \"<string>\",\n \"agentId\": \"<string>\",\n \"principalId\": \"<string>\",\n \"maxPerTransaction\": 123,\n \"totalCap\": 123,\n \"currency\": \"<string>\",\n \"allowedMerchants\": [\n \"<string>\"\n ],\n \"allowedCategories\": [\n \"<string>\"\n ],\n \"spent\": 123,\n \"authorizationCount\": 123,\n \"consentDigest\": \"<string>\",\n \"expiresAt\": 123,\n \"createdAt\": 123,\n \"updatedAt\": 123,\n \"revokedAt\": 123\n },\n \"config\": {\n \"hostedBaseUrl\": \"<string>\",\n \"merchant\": \"<string>\",\n \"category\": \"<string>\",\n \"buyerCountry\": \"<string>\",\n \"enabledNativeRails\": []\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/commerce/subscriptions/renew")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"subscription\": {\n \"id\": \"<string>\",\n \"cartId\": \"<string>\",\n \"principalId\": \"<string>\",\n \"mandateId\": \"<string>\",\n \"items\": [\n {\n \"productRetailerId\": \"<string>\",\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"currency\": \"<string>\"\n }\n ],\n \"currency\": \"<string>\",\n \"amount\": 123,\n \"cyclesCompleted\": 123,\n \"nextChargeAt\": 123,\n \"lastRenewalAt\": 123,\n \"lastRenewalReference\": \"<string>\",\n \"createdAt\": 123,\n \"updatedAt\": 123,\n \"pausedAt\": 123,\n \"canceledAt\": 123\n },\n \"mandate\": {\n \"id\": \"<string>\",\n \"agentId\": \"<string>\",\n \"principalId\": \"<string>\",\n \"maxPerTransaction\": 123,\n \"totalCap\": 123,\n \"currency\": \"<string>\",\n \"allowedMerchants\": [\n \"<string>\"\n ],\n \"allowedCategories\": [\n \"<string>\"\n ],\n \"spent\": 123,\n \"authorizationCount\": 123,\n \"consentDigest\": \"<string>\",\n \"expiresAt\": 123,\n \"createdAt\": 123,\n \"updatedAt\": 123,\n \"revokedAt\": 123\n },\n \"config\": {\n \"hostedBaseUrl\": \"<string>\",\n \"merchant\": \"<string>\",\n \"category\": \"<string>\",\n \"buyerCountry\": \"<string>\",\n \"enabledNativeRails\": []\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"subscription": {
"id": "<string>",
"cartId": "<string>",
"principalId": "<string>",
"mandateId": "<string>",
"channel": "whatsapp",
"items": [
{
"productRetailerId": "<string>",
"name": "<string>",
"quantity": 123,
"unitPrice": 123,
"currency": "<string>"
}
],
"currency": "<string>",
"amount": 123,
"interval": "weekly",
"status": "active",
"cyclesCompleted": 123,
"nextChargeAt": 123,
"lastRenewalAt": 123,
"lastRenewalReference": "<string>",
"createdAt": 123,
"updatedAt": 123,
"pausedAt": 123,
"canceledAt": 123
},
"mandate": {
"id": "<string>",
"agentId": "<string>",
"principalId": "<string>",
"maxPerTransaction": 123,
"totalCap": 123,
"currency": "<string>",
"allowedMerchants": [
"<string>"
],
"allowedCategories": [
"<string>"
],
"spent": 123,
"authorizationCount": 123,
"status": "active",
"consentDigest": "<string>",
"expiresAt": 123,
"createdAt": 123,
"updatedAt": 123,
"revokedAt": 123
},
"checkout": {},
"webhookEvent": {
"event": "<string>",
"subscriptionId": "<string>",
"cycleNumber": 123,
"amount": 123,
"currency": "<string>",
"channel": "whatsapp",
"chargeReference": "<string>",
"nextChargeAt": 123,
"occurredAt": 123
}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Headers
Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.
Required string length:
1 - 255Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.
Available options:
true, false Body
application/json
Serializable recurring subscription schedule snapshot. The renewal reuses the stored agent-payment-mandate authorization; the caller round-trips this snapshot in each request body.
Show child attributes
Show child attributes
Serializable AP2-style payment mandate snapshot. Carries a SHA-256 consent digest re-verified before every spend.
Show child attributes
Show child attributes
Show child attributes
Show child attributes