Create a recurring billing agreement from an AP2 open mandate
curl --request POST \
--url https://mag3nt.com/api/billing/agreements \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"open_mandate": "<string>",
"pay_link_code": "<string>",
"plan_ref": "membership:starter:month",
"amount": 123,
"description": "<string>",
"trigger": {
"type": "interval",
"metric": "mag3nt_fee_balance",
"floor": 123
},
"defer_first_charge": false
}
'import requests
url = "https://mag3nt.com/api/billing/agreements"
payload = {
"open_mandate": "<string>",
"pay_link_code": "<string>",
"plan_ref": "membership:starter:month",
"amount": 123,
"description": "<string>",
"trigger": {
"type": "interval",
"metric": "mag3nt_fee_balance",
"floor": 123
},
"defer_first_charge": False
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
open_mandate: '<string>',
pay_link_code: '<string>',
plan_ref: 'membership:starter:month',
amount: 123,
description: '<string>',
trigger: {type: 'interval', metric: 'mag3nt_fee_balance', floor: 123},
defer_first_charge: false
})
};
fetch('https://mag3nt.com/api/billing/agreements', 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://mag3nt.com/api/billing/agreements",
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([
'open_mandate' => '<string>',
'pay_link_code' => '<string>',
'plan_ref' => 'membership:starter:month',
'amount' => 123,
'description' => '<string>',
'trigger' => [
'type' => 'interval',
'metric' => 'mag3nt_fee_balance',
'floor' => 123
],
'defer_first_charge' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://mag3nt.com/api/billing/agreements"
payload := strings.NewReader("{\n \"open_mandate\": \"<string>\",\n \"pay_link_code\": \"<string>\",\n \"plan_ref\": \"membership:starter:month\",\n \"amount\": 123,\n \"description\": \"<string>\",\n \"trigger\": {\n \"type\": \"interval\",\n \"metric\": \"mag3nt_fee_balance\",\n \"floor\": 123\n },\n \"defer_first_charge\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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://mag3nt.com/api/billing/agreements")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"open_mandate\": \"<string>\",\n \"pay_link_code\": \"<string>\",\n \"plan_ref\": \"membership:starter:month\",\n \"amount\": 123,\n \"description\": \"<string>\",\n \"trigger\": {\n \"type\": \"interval\",\n \"metric\": \"mag3nt_fee_balance\",\n \"floor\": 123\n },\n \"defer_first_charge\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mag3nt.com/api/billing/agreements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"open_mandate\": \"<string>\",\n \"pay_link_code\": \"<string>\",\n \"plan_ref\": \"membership:starter:month\",\n \"amount\": 123,\n \"description\": \"<string>\",\n \"trigger\": {\n \"type\": \"interval\",\n \"metric\": \"mag3nt_fee_balance\",\n \"floor\": 123\n },\n \"defer_first_charge\": false\n}"
response = http.request(request)
puts response.read_body{
"agreement": {
"id": "ba_9f8e7d6c...",
"merchant_wallet": "<string>",
"payer_wallet": "<string>",
"payer_card_id": "<string>",
"pay_link_code": "<string>",
"plan_ref": "<string>",
"description": "<string>",
"amount": 123,
"asset": "<string>",
"network": "<string>",
"period_days": 123,
"threshold_metric": "mag3nt_fee_balance",
"threshold_floor": 123,
"funding_spender": "<string>",
"next_charge_at": "2023-11-07T05:31:56Z",
"last_charge_at": "2023-11-07T05:31:56Z",
"charges_made": 123,
"total_charged": 123,
"failure_count": 123,
"cancel_at_period_end": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"first_charge": {
"charge_id": "<string>",
"settlement_id": "<string>",
"error": "<string>"
}
}{
"error": "Card not found"
}{
"error": "Card not found"
}{
"error": "Card not found"
}{
"error": "Card not found"
}Billing
Create a recurring billing agreement from an AP2 open mandate
Consent is an AP2 open mandate carrying a payment.recurring constraint. Provide exactly one of pay_link_code (merchant billing) or plan_ref (platform plans, e.g. membership). Interval agreements charge period 1 inline unless defer_first_charge is set.
POST
/
api
/
billing
/
agreements
Create a recurring billing agreement from an AP2 open mandate
curl --request POST \
--url https://mag3nt.com/api/billing/agreements \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"open_mandate": "<string>",
"pay_link_code": "<string>",
"plan_ref": "membership:starter:month",
"amount": 123,
"description": "<string>",
"trigger": {
"type": "interval",
"metric": "mag3nt_fee_balance",
"floor": 123
},
"defer_first_charge": false
}
'import requests
url = "https://mag3nt.com/api/billing/agreements"
payload = {
"open_mandate": "<string>",
"pay_link_code": "<string>",
"plan_ref": "membership:starter:month",
"amount": 123,
"description": "<string>",
"trigger": {
"type": "interval",
"metric": "mag3nt_fee_balance",
"floor": 123
},
"defer_first_charge": False
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
open_mandate: '<string>',
pay_link_code: '<string>',
plan_ref: 'membership:starter:month',
amount: 123,
description: '<string>',
trigger: {type: 'interval', metric: 'mag3nt_fee_balance', floor: 123},
defer_first_charge: false
})
};
fetch('https://mag3nt.com/api/billing/agreements', 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://mag3nt.com/api/billing/agreements",
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([
'open_mandate' => '<string>',
'pay_link_code' => '<string>',
'plan_ref' => 'membership:starter:month',
'amount' => 123,
'description' => '<string>',
'trigger' => [
'type' => 'interval',
'metric' => 'mag3nt_fee_balance',
'floor' => 123
],
'defer_first_charge' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://mag3nt.com/api/billing/agreements"
payload := strings.NewReader("{\n \"open_mandate\": \"<string>\",\n \"pay_link_code\": \"<string>\",\n \"plan_ref\": \"membership:starter:month\",\n \"amount\": 123,\n \"description\": \"<string>\",\n \"trigger\": {\n \"type\": \"interval\",\n \"metric\": \"mag3nt_fee_balance\",\n \"floor\": 123\n },\n \"defer_first_charge\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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://mag3nt.com/api/billing/agreements")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"open_mandate\": \"<string>\",\n \"pay_link_code\": \"<string>\",\n \"plan_ref\": \"membership:starter:month\",\n \"amount\": 123,\n \"description\": \"<string>\",\n \"trigger\": {\n \"type\": \"interval\",\n \"metric\": \"mag3nt_fee_balance\",\n \"floor\": 123\n },\n \"defer_first_charge\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mag3nt.com/api/billing/agreements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"open_mandate\": \"<string>\",\n \"pay_link_code\": \"<string>\",\n \"plan_ref\": \"membership:starter:month\",\n \"amount\": 123,\n \"description\": \"<string>\",\n \"trigger\": {\n \"type\": \"interval\",\n \"metric\": \"mag3nt_fee_balance\",\n \"floor\": 123\n },\n \"defer_first_charge\": false\n}"
response = http.request(request)
puts response.read_body{
"agreement": {
"id": "ba_9f8e7d6c...",
"merchant_wallet": "<string>",
"payer_wallet": "<string>",
"payer_card_id": "<string>",
"pay_link_code": "<string>",
"plan_ref": "<string>",
"description": "<string>",
"amount": 123,
"asset": "<string>",
"network": "<string>",
"period_days": 123,
"threshold_metric": "mag3nt_fee_balance",
"threshold_floor": 123,
"funding_spender": "<string>",
"next_charge_at": "2023-11-07T05:31:56Z",
"last_charge_at": "2023-11-07T05:31:56Z",
"charges_made": 123,
"total_charged": 123,
"failure_count": 123,
"cancel_at_period_end": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"first_charge": {
"charge_id": "<string>",
"settlement_id": "<string>",
"error": "<string>"
}
}{
"error": "Card not found"
}{
"error": "Card not found"
}{
"error": "Card not found"
}{
"error": "Card not found"
}Authorizations
API key prefixed with 'Bearer sx_live_...'
Body
application/json
AP2 open mandate SD-JWT with a payment.recurring constraint.
Example:
"membership:starter:month"
Must not exceed the mandate's per-period cap.
Show child attributes
Show child attributes
⌘I