Agreement Definition

An agreement definition describes the agreement details.

Read Agreement Definition

Read the agreement definition from the item agreement selection.

Workflow

1. Start with item
2. GET the link with rel: agreements
3. GET the link with rel: element
4. GET the link with rel: definition
5. Render the response

Response Fields

Type: agreements.item-agreement

Name	Description	Type
agreement-length	The number of billing intervals in the agreement term.	integer
billing-interval	An object containing billing interval details for this agreement.	object
amount	The length of the billing interval, in units.	integer
unit	The unit of measure for the billing interval.	string
can-be-cancelled	Indicates if the subscription can be cancelled before the term ends.	boolean
can-be-paused	Indicates if the subscription can be paused.	boolean
display-name	The name to display on the client.	string
end-behaviour	Indicates what happens after the agreement term ends. Can contain ROLLOVER or EXPIRE.	string