Get a single Agreement object by ID.
List items in the Agreements collection.
Success
Success
Success
Id of existing agreement to update
Update details
Success
Details of the agreement to create
Created
Field | Type | Description |
---|
| string | Primary account identifier. Example: "AGR-2119-4550-8674" |
| string | Relative reference to object on API (always /commerce/agreements/{id}). Example: "/v1/commerce/agreements/AGR-2119-4550-8674" |
| string | The key status of the object. May only be specified on creation - Draft or Provisioning, and cannot be updated with |
| string | Agreement name, will be assigned automatically on creation, as Example: "Microsoft Office 365 NCE E1" |
| Example: |
| Example: |
| Example: |
| Example: |
| Example: |
| Example: |
| Listing | Reference to the listing which allows this agreement. Example: |
| Authorization | Reference to the Authorization object used for the agreement. Example: |
| 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 | Reference to Template object. Example: |
| ErrorObject | Markup text string explaining reason for provisining failure. Always set on moving status to Failed. Example: |
| Lines[] | List of items in Agreement. Example: |
| Subscription[] | Example: |
| OrderParameterValue [] | An object that holds a concise definition of a parameter, its value, and any associated errors. Example: |
| Order Parameter Object [] | An object that holds a concise definition of a parameter, its value, and any associated errors. Example: |
| 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: |
| ExternalIdsObject | Set of external IDs. Example: |
Reference to the vendor object filled-in on creation according product.
Reference to the Client object.
Reference to object.
Reference to the object.
Reference to the object.
Reference to the object.