Create a renewal cycle
curl --request POST \
--url https://api.tagada.io/v1/renewal-cycles \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'idempotency-key: <idempotency-key>' \
--data '
{
"amount": 1073741823,
"customer": "<string>",
"due_at": "2023-11-07T05:31:56Z",
"payment_method": "<string>",
"period_ref": "<string>",
"store": "<string>",
"subscription_group_id": "<string>",
"subscription_id": "<string>",
"test_clock": "<string>"
}
'import requests
url = "https://api.tagada.io/v1/renewal-cycles"
payload = {
"amount": 1073741823,
"customer": "<string>",
"due_at": "2023-11-07T05:31:56Z",
"payment_method": "<string>",
"period_ref": "<string>",
"store": "<string>",
"subscription_group_id": "<string>",
"subscription_id": "<string>",
"test_clock": "<string>"
}
headers = {
"idempotency-key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'idempotency-key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 1073741823,
customer: '<string>',
due_at: '2023-11-07T05:31:56Z',
payment_method: '<string>',
period_ref: '<string>',
store: '<string>',
subscription_group_id: '<string>',
subscription_id: '<string>',
test_clock: '<string>'
})
};
fetch('https://api.tagada.io/v1/renewal-cycles', 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.tagada.io/v1/renewal-cycles",
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([
'amount' => 1073741823,
'customer' => '<string>',
'due_at' => '2023-11-07T05:31:56Z',
'payment_method' => '<string>',
'period_ref' => '<string>',
'store' => '<string>',
'subscription_group_id' => '<string>',
'subscription_id' => '<string>',
'test_clock' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"idempotency-key: <idempotency-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://api.tagada.io/v1/renewal-cycles"
payload := strings.NewReader("{\n \"amount\": 1073741823,\n \"customer\": \"<string>\",\n \"due_at\": \"2023-11-07T05:31:56Z\",\n \"payment_method\": \"<string>\",\n \"period_ref\": \"<string>\",\n \"store\": \"<string>\",\n \"subscription_group_id\": \"<string>\",\n \"subscription_id\": \"<string>\",\n \"test_clock\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("idempotency-key", "<idempotency-key>")
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.tagada.io/v1/renewal-cycles")
.header("idempotency-key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 1073741823,\n \"customer\": \"<string>\",\n \"due_at\": \"2023-11-07T05:31:56Z\",\n \"payment_method\": \"<string>\",\n \"period_ref\": \"<string>\",\n \"store\": \"<string>\",\n \"subscription_group_id\": \"<string>\",\n \"subscription_id\": \"<string>\",\n \"test_clock\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tagada.io/v1/renewal-cycles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["idempotency-key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 1073741823,\n \"customer\": \"<string>\",\n \"due_at\": \"2023-11-07T05:31:56Z\",\n \"payment_method\": \"<string>\",\n \"period_ref\": \"<string>\",\n \"store\": \"<string>\",\n \"subscription_group_id\": \"<string>\",\n \"subscription_id\": \"<string>\",\n \"test_clock\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"amount": 1073741823,
"card_update_until": "2023-11-07T05:31:56Z",
"concluded_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"currency": "<string>",
"customer": "<string>",
"due_at": "2023-11-07T05:31:56Z",
"ending": "cancel",
"id": "<string>",
"mode": "live",
"next_try_at": "2023-11-07T05:31:56Z",
"notice_sent_at": "2023-11-07T05:31:56Z",
"object": "renewal_cycle",
"outcome_reason": "<string>",
"payment_method": "<string>",
"period_ref": "<string>",
"policy_version": "<string>",
"status": "scheduled",
"store": "<string>",
"subscription_group_id": "<string>",
"subscription_id": "<string>",
"test_clock": "<string>",
"tries": [
{
"amount": 1073741823,
"payment": "<string>",
"priced": true,
"processor": "<string>",
"retry": 1,
"state": "trying",
"switched": true
}
]
}{
"error": {
"code": "amount_out_of_range",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"type": "invalid_request_error",
"details": {
"credential_reason": "inactive_instrument",
"cycle_id": "<string>",
"earliest_at": "2023-11-07T05:31:56Z",
"first_seen": true,
"reason": "store_not_on_payments_api"
}
}
}{
"error": {
"code": "amount_out_of_range",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"type": "invalid_request_error",
"details": {
"credential_reason": "inactive_instrument",
"cycle_id": "<string>",
"earliest_at": "2023-11-07T05:31:56Z",
"first_seen": true,
"reason": "store_not_on_payments_api"
}
}
}{
"error": {
"code": "amount_out_of_range",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"type": "invalid_request_error",
"details": {
"credential_reason": "inactive_instrument",
"cycle_id": "<string>",
"earliest_at": "2023-11-07T05:31:56Z",
"first_seen": true,
"reason": "store_not_on_payments_api"
}
}
}{
"error": {
"code": "amount_out_of_range",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"type": "invalid_request_error",
"details": {
"credential_reason": "inactive_instrument",
"cycle_id": "<string>",
"earliest_at": "2023-11-07T05:31:56Z",
"first_seen": true,
"reason": "store_not_on_payments_api"
}
}
}{
"error": {
"code": "amount_out_of_range",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"type": "invalid_request_error",
"details": {
"credential_reason": "inactive_instrument",
"cycle_id": "<string>",
"earliest_at": "2023-11-07T05:31:56Z",
"first_seen": true,
"reason": "store_not_on_payments_api"
}
}
}{
"error": {
"code": "amount_out_of_range",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"type": "invalid_request_error",
"details": {
"credential_reason": "inactive_instrument",
"cycle_id": "<string>",
"earliest_at": "2023-11-07T05:31:56Z",
"first_seen": true,
"reason": "store_not_on_payments_api"
}
}
}{
"error": {
"code": "amount_out_of_range",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"type": "invalid_request_error",
"details": {
"credential_reason": "inactive_instrument",
"cycle_id": "<string>",
"earliest_at": "2023-11-07T05:31:56Z",
"first_seen": true,
"reason": "store_not_on_payments_api"
}
}
}{
"error": {
"code": "amount_out_of_range",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"type": "invalid_request_error",
"details": {
"credential_reason": "inactive_instrument",
"cycle_id": "<string>",
"earliest_at": "2023-11-07T05:31:56Z",
"first_seen": true,
"reason": "store_not_on_payments_api"
}
}
}{
"error": {
"code": "amount_out_of_range",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"type": "invalid_request_error",
"details": {
"credential_reason": "inactive_instrument",
"cycle_id": "<string>",
"earliest_at": "2023-11-07T05:31:56Z",
"first_seen": true,
"reason": "store_not_on_payments_api"
}
}
}Renewal cycles
Create a renewal cycle
Claims one subscription or group period (V2’s billing_period_key) and collects it. A second create for the period answers cycle_exists_for_period with its cycle_id; a period V2 holds answers period_claimed_by_v2; another period of a subject whose cycle is still open answers cycle_open_for_subject.
POST
/
v1
/
renewal-cycles
Create a renewal cycle
curl --request POST \
--url https://api.tagada.io/v1/renewal-cycles \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'idempotency-key: <idempotency-key>' \
--data '
{
"amount": 1073741823,
"customer": "<string>",
"due_at": "2023-11-07T05:31:56Z",
"payment_method": "<string>",
"period_ref": "<string>",
"store": "<string>",
"subscription_group_id": "<string>",
"subscription_id": "<string>",
"test_clock": "<string>"
}
'import requests
url = "https://api.tagada.io/v1/renewal-cycles"
payload = {
"amount": 1073741823,
"customer": "<string>",
"due_at": "2023-11-07T05:31:56Z",
"payment_method": "<string>",
"period_ref": "<string>",
"store": "<string>",
"subscription_group_id": "<string>",
"subscription_id": "<string>",
"test_clock": "<string>"
}
headers = {
"idempotency-key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'idempotency-key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 1073741823,
customer: '<string>',
due_at: '2023-11-07T05:31:56Z',
payment_method: '<string>',
period_ref: '<string>',
store: '<string>',
subscription_group_id: '<string>',
subscription_id: '<string>',
test_clock: '<string>'
})
};
fetch('https://api.tagada.io/v1/renewal-cycles', 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.tagada.io/v1/renewal-cycles",
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([
'amount' => 1073741823,
'customer' => '<string>',
'due_at' => '2023-11-07T05:31:56Z',
'payment_method' => '<string>',
'period_ref' => '<string>',
'store' => '<string>',
'subscription_group_id' => '<string>',
'subscription_id' => '<string>',
'test_clock' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"idempotency-key: <idempotency-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://api.tagada.io/v1/renewal-cycles"
payload := strings.NewReader("{\n \"amount\": 1073741823,\n \"customer\": \"<string>\",\n \"due_at\": \"2023-11-07T05:31:56Z\",\n \"payment_method\": \"<string>\",\n \"period_ref\": \"<string>\",\n \"store\": \"<string>\",\n \"subscription_group_id\": \"<string>\",\n \"subscription_id\": \"<string>\",\n \"test_clock\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("idempotency-key", "<idempotency-key>")
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.tagada.io/v1/renewal-cycles")
.header("idempotency-key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 1073741823,\n \"customer\": \"<string>\",\n \"due_at\": \"2023-11-07T05:31:56Z\",\n \"payment_method\": \"<string>\",\n \"period_ref\": \"<string>\",\n \"store\": \"<string>\",\n \"subscription_group_id\": \"<string>\",\n \"subscription_id\": \"<string>\",\n \"test_clock\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tagada.io/v1/renewal-cycles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["idempotency-key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 1073741823,\n \"customer\": \"<string>\",\n \"due_at\": \"2023-11-07T05:31:56Z\",\n \"payment_method\": \"<string>\",\n \"period_ref\": \"<string>\",\n \"store\": \"<string>\",\n \"subscription_group_id\": \"<string>\",\n \"subscription_id\": \"<string>\",\n \"test_clock\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"amount": 1073741823,
"card_update_until": "2023-11-07T05:31:56Z",
"concluded_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"currency": "<string>",
"customer": "<string>",
"due_at": "2023-11-07T05:31:56Z",
"ending": "cancel",
"id": "<string>",
"mode": "live",
"next_try_at": "2023-11-07T05:31:56Z",
"notice_sent_at": "2023-11-07T05:31:56Z",
"object": "renewal_cycle",
"outcome_reason": "<string>",
"payment_method": "<string>",
"period_ref": "<string>",
"policy_version": "<string>",
"status": "scheduled",
"store": "<string>",
"subscription_group_id": "<string>",
"subscription_id": "<string>",
"test_clock": "<string>",
"tries": [
{
"amount": 1073741823,
"payment": "<string>",
"priced": true,
"processor": "<string>",
"retry": 1,
"state": "trying",
"switched": true
}
]
}{
"error": {
"code": "amount_out_of_range",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"type": "invalid_request_error",
"details": {
"credential_reason": "inactive_instrument",
"cycle_id": "<string>",
"earliest_at": "2023-11-07T05:31:56Z",
"first_seen": true,
"reason": "store_not_on_payments_api"
}
}
}{
"error": {
"code": "amount_out_of_range",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"type": "invalid_request_error",
"details": {
"credential_reason": "inactive_instrument",
"cycle_id": "<string>",
"earliest_at": "2023-11-07T05:31:56Z",
"first_seen": true,
"reason": "store_not_on_payments_api"
}
}
}{
"error": {
"code": "amount_out_of_range",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"type": "invalid_request_error",
"details": {
"credential_reason": "inactive_instrument",
"cycle_id": "<string>",
"earliest_at": "2023-11-07T05:31:56Z",
"first_seen": true,
"reason": "store_not_on_payments_api"
}
}
}{
"error": {
"code": "amount_out_of_range",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"type": "invalid_request_error",
"details": {
"credential_reason": "inactive_instrument",
"cycle_id": "<string>",
"earliest_at": "2023-11-07T05:31:56Z",
"first_seen": true,
"reason": "store_not_on_payments_api"
}
}
}{
"error": {
"code": "amount_out_of_range",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"type": "invalid_request_error",
"details": {
"credential_reason": "inactive_instrument",
"cycle_id": "<string>",
"earliest_at": "2023-11-07T05:31:56Z",
"first_seen": true,
"reason": "store_not_on_payments_api"
}
}
}{
"error": {
"code": "amount_out_of_range",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"type": "invalid_request_error",
"details": {
"credential_reason": "inactive_instrument",
"cycle_id": "<string>",
"earliest_at": "2023-11-07T05:31:56Z",
"first_seen": true,
"reason": "store_not_on_payments_api"
}
}
}{
"error": {
"code": "amount_out_of_range",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"type": "invalid_request_error",
"details": {
"credential_reason": "inactive_instrument",
"cycle_id": "<string>",
"earliest_at": "2023-11-07T05:31:56Z",
"first_seen": true,
"reason": "store_not_on_payments_api"
}
}
}{
"error": {
"code": "amount_out_of_range",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"type": "invalid_request_error",
"details": {
"credential_reason": "inactive_instrument",
"cycle_id": "<string>",
"earliest_at": "2023-11-07T05:31:56Z",
"first_seen": true,
"reason": "store_not_on_payments_api"
}
}
}{
"error": {
"code": "amount_out_of_range",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"type": "invalid_request_error",
"details": {
"credential_reason": "inactive_instrument",
"cycle_id": "<string>",
"earliest_at": "2023-11-07T05:31:56Z",
"first_seen": true,
"reason": "store_not_on_payments_api"
}
}
}Authorizations
Secret, platform or publishable API key. Platform keys require Payments-Account.
Headers
Required for platform keys; refused for secret/publishable keys.
Available options:
2026-11-01 Required string length:
1 - 255Body
application/json
Integer amount in the currency minor unit.
Required range:
0 <= x <= 2147483647Available options:
AED, AFN, ALL, AMD, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, 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, INR, IQD, IRR, ISK, 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, MXV, 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, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XCD, XCG, XOF, XPF, YER, ZAR, ZMW, ZWG Pattern:
^cus_[a-f0-9]{12}$Pattern:
^inst_[a-f0-9]{12}$V2's billing_period_key.
Minimum string length:
1Pattern:
^store_[a-f0-9]{12}$Minimum string length:
1Minimum string length:
1Test mode only.
Pattern:
^clk_[0-9a-hjkmnp-tv-z]{26}$Response
Renewal cycle with its tries.
Integer amount in the currency minor unit.
Required range:
0 <= x <= 2147483647Available options:
cancel, pause, null Pattern:
^rcy_[0-9a-hjkmnp-tv-z]{26}$Available options:
live, test Available options:
renewal_cycle Available options:
scheduled, trying, waiting_retry, waiting_card_update, waiting_customer, waiting_merchant, succeeded, failed, canceled Pattern:
^clk_[0-9a-hjkmnp-tv-z]{26}$Show child attributes
Show child attributes