---
title: "Retrieve an amendment"
method: GET
path: "/object-query/amendments/{key}"
tags: ["Object Queries"]
---

# Retrieve an amendment

`GET /object-query/amendments/{key}`

Retrieve the details of a specific Amendment object.

## Path parameters

- `key` string, required

## Query parameters

- `pageSize` integer
- `cursor` string
- `sort[]` string[]
- `expand[]` string[]
- `filter[]` string[]
- `fields[]` string[]
- `includeNullFields` boolean

## Headers

- `Idempotency-Key` string
- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Version` string

## Response `200`

OK

- ExpandedAmendment
  - `id` string — The unique identifier of the amendment.
  - `createdById` string — The unique identifier of the user who created the amendment.
  - `createdDate` string, date-time — The time that the amendment gets created in the system, in the `YYYY-MM-DD HH:MM:SS` format.
  - `updatedById` string — The unique identifier of the user who last updated the amendment.
  - `updatedDate` string, date-time — The time that the amendment gets updated in the system, in the `YYYY-MM-DD HH:MM:SS` format.
  - `autoRenew` boolean — Indicates whether the amendment is automatically renewed.
  - `code` string — The amendment code.
  - `contractEffectiveDate` string, date — The date when the amendment becomes effective for billing purposes, as `yyyy-mm-dd`.
  - `currentTerm` integer — The length of the period for the current subscription term.
  - `currentTermPeriodType` 'Month' | 'Year' | 'Day' | 'Week' — The period type for the current subscription term.
  - `customerAcceptanceDate` string, date — The date when the customer accepts the amendment changes to the subscription, as `yyyy-mm-dd`.
  - `description` string — Description of the amendment.
  - `effectiveDate` string, date — The date when the amendment changes take effective.
  - `effectivePolicy` 'EffectiveImmediately' | 'EffectiveEndOfBillingPeriod' | 'SpecificDate' — Effective Policy for the subscription. The value depends on the following conditions: * If the rate plan change (from old to new) is an upgrade, the effective policy is `EffectiveImmediately` by default. * If the rate plan change (from old to new) is a downgrade, the effective policy is `EffectiveEndOfBillingPeriod` by default. * Otherwise, the effective policy is `SpecificDate` by default. **Note:** This feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/).
  - `name` string — The name of the amendment.
  - `newRatePlanId` string — The ID of the rate plan charge on which amendment is made. Only the Add or Update amendment returns a new rate plan ID.
  - `removedRatePlanId` string — The ID of the rate plan charge that is removed from the subscription. Only the Remove Product amendment returns a removed rate plan ID.
  - `renewalSetting` 'RENEW_WITH_SPECIFIC_TERM' | 'RENEW_TO_EVERGREEN' — Specifies whether a termed subscription will remain termed or change to evergreen when it is renewed.
  - `renewalTerm` integer — The term of renewal for the amended subscription.
  - `renewalTermPeriodType` 'Month' | 'Year' | 'Day' | 'Week' — The period type for the subscription renewal term.
  - `resumeDate` string, date — The date when the subscription resumption takes effect, as `yyyy-mm-dd`. **Note:** This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).
  - `serviceActivationDate` string, date — The date when service is activated, as `yyyy-mm-dd`.
  - `specificUpdateDate` string, date — The date when the Update Product amendment takes effect. Only for the Update Product amendments if there is already a future-dated Update Product amendment on the subscription.
  - `status` 'Draft' | 'Pending Activation' | 'Pending Acceptance' | 'Completed' — The status of the amendment.
  - `subscriptionId` string — The ID of the subscription based on which the amendment is created.
  - `suspendDate` string, date — The date when the subscription suspension takes effect, as `yyyy-mm-dd`. **Note:** This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).
  - `termStartDate` string, date — The date when the new terms and conditions take effect.
  - `termType` 'TERMED' | 'EVERGREEN' — Indicates if the subscription is termed or evergreen.
  - `type` 'Cancellation' | 'NewProduct' | 'OwnerTransfer' | 'RemoveProduct' | 'Renewal' | 'UpdateProduct' | 'TermsAndConditions' | 'ChangePlan' | 'Composite' — Type of the amendment.
  - `subType` 'Upgrade' | 'Downgrade' | 'Crossgrade' | 'PlanChanged' — The sub type for the change plan order action. If this field was not set by user, the field is automatically generated by the system according to the following rules: When the old and new rate plans are within the same Grading catalog group: * If the grade of new plan is greater than that of the old plan, this is an "Upgrade". * If the grade of new plan is less than that of the old plan, this is a "Downgrade". * If the grade of new plan equals that of the old plan, this is a "Crossgrade". When the old and new rate plans are not in the same Grading catalog group, or either has no group, this is "PlanChanged".
  - `bookingDate` string, date

## Other responses

- `500` — Internal server error
- `4XX` — Invalid input

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/702f3caf3985/schema)