Get Agreement
curl --request GET \
--url https://api.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/agreements/{agreement_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/agreements/{agreement_id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/agreements/{agreement_id}', 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.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/agreements/{agreement_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/agreements/{agreement_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/agreements/{agreement_id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/agreements/{agreement_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"object": "agreement",
"id": "aagr_2k9m4p7q1w8e5r3t6y0u2i4",
"title": "Partner Platform Agreement (Non-US)",
"version": "v1",
"content_url": "https://docs.platform.example/agreements/partner-platform-agreement-non-us-v1.pdf",
"status": "pending",
"responded_at": null,
"created_at": "2026-06-22T08:30:00Z",
"updated_at": "2026-06-22T08:30:00Z"
}
Agreements
Get Agreement
Fetch one assigned agreement for an account
GET
/
ads
/
v1
/
customers
/
{customer_id}
/
accounts
/
{account_id}
/
agreements
/
{agreement_id}
Get Agreement
curl --request GET \
--url https://api.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/agreements/{agreement_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/agreements/{agreement_id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/agreements/{agreement_id}', 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.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/agreements/{agreement_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/agreements/{agreement_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/agreements/{agreement_id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hopnow.io/ads/v1/customers/{customer_id}/accounts/{account_id}/agreements/{agreement_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"object": "agreement",
"id": "aagr_2k9m4p7q1w8e5r3t6y0u2i4",
"title": "Partner Platform Agreement (Non-US)",
"version": "v1",
"content_url": "https://docs.platform.example/agreements/partner-platform-agreement-non-us-v1.pdf",
"status": "pending",
"responded_at": null,
"created_at": "2026-06-22T08:30:00Z",
"updated_at": "2026-06-22T08:30:00Z"
}
Returns one assigned agreement for the account.
Path Parameters
string
required
Identifier of the Platform customer (
cus_…).string
required
Identifier of the Platform end-customer account (
acct_…).string
required
Assigned agreement id (
aagr_…).Response
Returns 200 with an agreement object.string
Always
agreement.string
Assigned agreement id (
aagr_…).string
Agreement title.
string
Agreement version.
string
URL of the agreement document to render to the end customer.
enum
One of
pending, accepted, or rejected.string
ISO 8601 timestamp of the response;
null while pending.string
ISO 8601 timestamp when the agreement was assigned.
string
ISO 8601 timestamp when the agreement was last updated.
{
"object": "agreement",
"id": "aagr_2k9m4p7q1w8e5r3t6y0u2i4",
"title": "Partner Platform Agreement (Non-US)",
"version": "v1",
"content_url": "https://docs.platform.example/agreements/partner-platform-agreement-non-us-v1.pdf",
"status": "pending",
"responded_at": null,
"created_at": "2026-06-22T08:30:00Z",
"updated_at": "2026-06-22T08:30:00Z"
}
⌘I