Agreements
Agreements Object
The agreement represents an instance of a relationship between Seller, Buyer, and Licensee. It may refer to one-time purchases or/and set of subscriptions.
id
string
Primary account identifier.
Example: "AGR-2119-4550-8674"
href
string
Relative reference to object on API (always /commerce/agreements/{id}).
Example: "/v1/commerce/agreements/AGR-2119-4550-8674"
status
string
The key status of the object. May only be specified on creation - Draft or Provisioning, and cannot be updated with PUT.
name
string
Agreement name, will be assigned automatically on creation, as {product.name} for {licensee.name} but can be changed later.
Example: "Microsoft Office 365 NCE E1"
vendor
Example:
client
Example:
buyer
Example:
seller
Example:
licensee
Example:
product
Example:
listing
Listing
Reference to the listing which allows this agreement.
Example:
authorization
Authorization
Reference to the Authorization object used for the agreement.
Example:
price
Price
The price for the agreement, explains the monthly and yearly prices for the whole agreement, one-time price tags are never included into it. different parts of price object visible to different actors, see Price Object.
Example:
template
Template
Reference to Template object.
Example:
error
ErrorObject
Markup text string explaining reason for provisining failure. Always set on moving status to Failed.
Example:
lines
Lines[]
List of items in Agreement.
Example:
subscriptions
Subscription[]
Example:
parameters.fulfillment
OrderParameterValue []
An object that holds a concise definition of a parameter, its value, and any associated errors.
Example:
parameters.ordering
Order Parameter Object []
An object that holds a concise definition of a parameter, its value, and any associated errors.
Example:
audit
AuditObject
Audit object with possible entries: created, updated, activated, terminated, according to the object's lifecycle.
Possible audit events include Created, Updated, Activated, Terminated, and Failed.
Example:
externalIds
ExternalIdsObject
Set of external IDs.
Example:
Example
Last updated
Was this helpful?