show

GET 
/v1/agreements/:id

show

Request

Path Parameters

id stringrequired
Example: 01904429-927e-7fa1-a341-3915e973f3fa

Responses

200

returns an agreement

application/json

Schema

Schema

id string
agreement_id string
type string
first_order_id string
max_use integer
variability string
expiry stringnullable
created_at string
updated_at string

Example (from schema)

{
  "id": "string",
  "agreement_id": "string",
  "type": "string",
  "first_order_id": "string",
  "max_use": 0,
  "variability": "string",
  "expiry": "string",
  "created_at": "string",
  "updated_at": "string"
}

Example

{
  "id": "01904429-8f8b-76ff-bd53-15187ed9268b",
  "agreement_id": "ec3a749f-c4cb-4acc-b5ac-66d391292927",
  "type": "unscheduled",
  "first_order_id": "01904429-8f89-7bbe-9a1f-98ba806825ca",
  "max_use": 6,
  "variability": "variable",
  "expiry": null,
  "created_at": "2024-06-23T08:14:52Z",
  "updated_at": "2024-06-23T08:14:52Z"
}

401

returns unauthorized

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "string"
}

Example

{
  "message": "Missing authentication information"
}

403

returns forbidden

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "string"
}

Example

{
  "message": "Unauthorized"
}

Loading...