Jump to

• Request
• Response

Get Agreement Offer Details

get

/subscriptions/agreement/offer/{id}

Gets catalog details for an offer and agreement-specific overrides when an agreement is supplied.

Request

Path Parameters

• id(required): string
  The ID of the offer.

Query Parameters

• accountObj: string
  ID of the account object.
• agreementObj: string
  ID of the agreement object.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The agreement-aware offer details were returned successfully.

Body ()

Root Schema : AgreementOfferDetails

Type: object

Show Source

• accountRef: object ResourceRef
• agreement: array agreement
• agreementRef: object ResourceRef
• attributeRef: object ResourceRef
• attributes: array attributes
• description: string
• id(required): object ResourceRef
• name: string
• permitted: string
• usageMap: array usageMap

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "agreementRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "description":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "permitted":{
            "type":"string"
        },
        "attributeRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "attributes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Attribute"
            }
        },
        "usageMap":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UsageMap"
            }
        },
        "agreement":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AgreementOfferDetailsOverride"
            }
        }
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : agreement

Type: array

Show Source

• Array of: object AgreementOfferDetailsOverride

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AgreementOfferDetailsOverride"
    }
}

Nested Schema : attributes

Type: array

Show Source

• Array of: object Attribute

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Attribute"
    }
}

Nested Schema : usageMap

Type: array

Show Source

• Array of: object UsageMap

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/UsageMap"
    }
}

Nested Schema : AgreementOfferDetailsOverride

Type: object

Show Source

• accountRef: object ResourceRef
• attributes: array attributes
• id(required): string
• offerRef: object ResourceRef
• usageMap: array usageMap

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "offerRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "attributes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Attribute"
            }
        },
        "usageMap":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AgreementOfferDetailsUsageMap"
            }
        }
    }
}

Nested Schema : attributes

Type: array

Show Source

• Array of: object Attribute

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Attribute"
    }
}

Nested Schema : usageMap

Type: array

Show Source

• Array of: object AgreementOfferDetailsUsageMap

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AgreementOfferDetailsUsageMap"
    }
}

Nested Schema : Attribute

Type: object

Show Source

• name(required): string
• value: string

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Nested Schema : AgreementOfferDetailsUsageMap

Type: object

Show Source

• dateRange: array dateRange
• end: integer (int64)
• eventType: string

{
    "type":"object",
    "properties":{
        "eventType":{
            "type":"string"
        },
        "end":{
            "type":"integer",
            "format":"int64"
        },
        "dateRange":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DateRange"
            }
        }
    }
}

Nested Schema : dateRange

Type: array

Show Source

• Array of: object DateRange

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DateRange"
    }
}

Nested Schema : DateRange

Type: object

Show Source

• end: integer (int64)
• priceTag: array priceTag
• start: integer (int64)

{
    "type":"object",
    "properties":{
        "start":{
            "type":"integer",
            "format":"int64"
        },
        "end":{
            "type":"integer",
            "format":"int64"
        },
        "priceTag":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PriceTag"
            }
        }
    }
}

Nested Schema : priceTag

Type: array

Show Source

• Array of: object PriceTag

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PriceTag"
    }
}

Nested Schema : PriceTag

Type: object

Show Source

• amount: number
• attributeName: string
• defaultValue: string
• description: string
• name(required): string
• percent: number
• resourceId: integer (int32)
• tagScope: string

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "attributeName":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "tagScope":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "defaultValue":{
            "type":"string"
        },
        "amount":{
            "type":"number"
        },
        "percent":{
            "type":"number"
        },
        "resourceId":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : UsageMap

Type: object

Show Source

• attribute: array attribute
• dateRange: array dateRange
• discountModel: array discountModel
• event: string
• priceTagInfoRef: object ResourceRef
• ratePlan: array ratePlan

{
    "type":"object",
    "properties":{
        "event":{
            "type":"string"
        },
        "attribute":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Attribute"
            }
        },
        "priceTagInfoRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "ratePlan":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RatePlan"
            }
        },
        "discountModel":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DiscountModel"
            }
        },
        "dateRange":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DateRange"
            }
        }
    }
}

Nested Schema : attribute

Type: array

Show Source

• Array of: object Attribute

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Attribute"
    }
}

Nested Schema : dateRange

Type: array

Show Source

• Array of: object DateRange

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DateRange"
    }
}

Nested Schema : discountModel

Type: array

Show Source

• Array of: object DiscountModel

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DiscountModel"
    }
}

Nested Schema : ratePlan

Type: array

Show Source

• Array of: object RatePlan

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RatePlan"
    }
}

Nested Schema : DiscountModel

Type: object

Show Source

• name: string
• priceTag: array priceTag

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "priceTag":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PriceTag"
            }
        }
    }
}

Nested Schema : priceTag

Type: array

Show Source

• Array of: object PriceTag

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PriceTag"
    }
}

Nested Schema : RatePlan

Type: object

Show Source

• name: string
• priceTag: array priceTag

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "priceTag":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PriceTag"
            }
        }
    }
}

Nested Schema : priceTag

Type: array

Show Source

• Array of: object PriceTag

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PriceTag"
    }
}

404 Response

The specified offer ID was not found.

500 Response

An internal server error occurred.

Back to Top