Knowledge Center

Knowledge Center > API > REST API > REST API Reference > Amendments > Get Amendments By Subscription Id

Get Amendments By Subscription Id

This REST API reference describes how to retrieve detailed information about an amendment with the specified subscription.

Request

  • Production: GET https://api.zuora.com/rest/v1/amendments/subscriptions/{subscription-id}
  • API Sandbox: GET https://apisandbox-api.zuora.com/rest/v1/amendments/subscriptions/{subscription-id}

Request parameter

subscription-id

required

path

The ID of the subscription on which amendment changes you want to retrieve.

Response

success

Contains true if successful, otherwise false.

id

Internal process ID to assist Zuora support.

reasons

Information on one or more reasons for the result. Only returned if success is false.

code

Eight-digit numeric error code

message

Description of the error

Amendment

Contains information about the subscription amendment. 

id

The amendment ID.

code

The amendment code.

name

The name of the amendment.

type

Type of the amendment.

Possible values are:

  • Cancellation

  • NewProduct

  • OwnerTransfer

  • RemoveProduct

  • Renewal

  • UpdateProduct

  • TermsAndConditions

description

Description of the amendment.

status

The status of the amendment. This field only returns Completed status.

suspendDate

The date when the subscription suspension takes effect, as yyyy-mm-dd.

This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support

resumeDate

The date when the subscription resumption takes effect, as yyyy-mm-dd.

This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support

contractEffectiveDate

The date when the amendment becomes effective for billing purposes, as yyyy-mm-dd.

serviceActivationDate

The date when service is activated, as yyyy-mm-dd.

customerAcceptanceDate

The date when the customer accepts the amendment changes to the subscription, as yyyy-mm-dd.

effectiveDate

The date when the amendment changes take effective. 

newSubscriptionId

The ID of the subscription that the amendment changes.

baseSubscriptionId

The ID of the subscription based on which the amendment is created.

termType

Indicates if the subscription is TERMED or EVERGREEN.

currentTerm

The length of the period for the current subscription term. 

currentTermPeriodType

The period type for the current subscription term.

Possible values are:

  • Month
  • Year
  • Day
  • Week

termStartDate

The date when the new terms and conditions take effect.

renewalSetting

Specifies whether a termed subscription will remain termed or change to evergreen when it is renewed.

Possible values are:

  • RENEW_WITH_SPECIFIC_TERM 

  • RENEW_TO_EVERGREEN

renewalTerm

The term of renewal for the amended subscription.

renewalTermPeriodType

The period type for the subscription renewal term.

Possible values are:

  • Month 

  • Year

  • Day

  • Week

autoRenew

Determines whether the subscription is automatically renewed, or whether it expires at the end of the term and needs to be manually renewed. 

specificUpdateDate

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.

newRatePlanId

The ID of the rate plan charge on which changes are made. Only the Add or Update amendment returns a new rate plan ID.

baseRatePlanId

The rate plan ID on which changes are made. Only the Update or Remove amendment returns a base rate plan ID.

destinationAccountId

The ID of the account that the subscription is being transferred to.

destinationInvoiceOwnerId

The ID of the invoice that the subscription is being transferred to.

Examples

HTTP/JSON request:

GET https://api.zuora.com/rest/v1/amendments/subscriptions​/402896a9529c100a01529c311930001d

JSON response:

{
    "success": true,
    "id": "402896a9529c100a01529c30e26a0018",
    "code": "A-AM00000002",
    "name": "testAmendment",
    "type": "TermsAndConditions",
    "description": "just for test",
    "status": "Completed",
    "contractEffectiveDate": "2016-02-01",
    "serviceActivationDate": "2016-02-01",
    "customerAcceptanceDate": "2016-02-01",
    "effectiveDate": "2016-02-01",
    "newSubscriptionId": "402896a9529c100a01529c311930001d",
    "baseSubscriptionId": "402896a9529c100a01529c2f2cc30010",
    "termType": "TERMED",
    "currentTerm": 2,
    "termStartDate": "2015-12-31",
    "renewalSetting": "RENEW_WITH_SPECIFIC_TERM",
    "renewalTerm": 1,
    "renewalTermPeriodType": "Month",
    "autoRenew": false,
    "specificUpdateDate": null,
    "newRatePlanId": null,
    "baseRatePlanId": null,
    "destinationAccountId": "402896a9529bc3dc01529bcba7120023",
    "destinationInvoiceOwnerId": "402896a9529bc3dc01529bcba7120023"
}

CURL request:

##\
## get amendment by key
## "=============Get File ===========" echo echo< curl -i -k -H "apiAccessKeyId:$USER_NAME" -H " apiSecretAccessKey:$PASSWORD" -H "Accept:application/json" -X GET $BASE_URL/v1/amendments/subscriptions/402896a9529c100a01529c311930001d

JSON response:

{
    "success": true,
    "id": "402896a9529c100a01529c30e26a0018",
    "code": "A-AM00000002",
    "name": "testAmendment",
    "type": "TermsAndConditions",
    "description": "just for test",
    "status": "Completed",
    "contractEffectiveDate": "2016-02-01",
    "serviceActivationDate": "2016-02-01",
    "customerAcceptanceDate": "2016-02-01",
    "effectiveDate": "2016-02-01",
    "newSubscriptionId": "402896a9529c100a01529c311930001d",
    "baseSubscriptionId": "402896a9529c100a01529c2f2cc30010",
    "termType": "TERMED",
    "currentTerm": 2,
    "termStartDate": "2015-12-31",
    "renewalSetting": "RENEW_WITH_SPECIFIC_TERM",
    "renewalTerm": 1,
    "renewalTermPeriodType": "Month",
    "autoRenew": false,
    "specificUpdateDate": null,
    "newRatePlanId": null,
    "baseRatePlanId": null,
    "destinationAccountId": "402896a9529bc3dc01529bcba7120023",
    "destinationInvoiceOwnerId": "402896a9529bc3dc01529bcba7120023"
}
Last modified
22:14, 18 Apr 2016

Tags

This page has no custom tags.

Classifications

(not set)