Skip to main content
GET
Get Agreement
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.