POST /v1/adjustments

Describes how to create one or more delivery adjustments for a subscription.

Notes:

The Delivery Adjustments 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. To manage and access this feature through the self-service interface, see Enable billing features by yourself in the Knowledge Center.
This operation supports a partial success scenario: when at least one eligible delivery adjustment exists for a given time period, “success = true” as well as eligible delivery adjustments and ineligible delivery adjustments are returned in the response; only when no delivery adjustment is eligible, “success=false” is returned.

Servers

https://rest.test.zuora.com
https://rest.sandbox.na.zuora.com
https://rest.apisandbox.zuora.com
https://rest.na.zuora.com
https://rest.zuora.com
https://rest.test.eu.zuora.com
https://rest.sandbox.eu.zuora.com
https://rest.eu.zuora.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"
`Content-Encoding`	String	No	Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
`Zuora-Track-Id`	String	No	A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).
`Authorization`	String	No	The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling Create an OAuth token.
`Idempotency-Key`	String	No	Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
`Zuora-Entity-Ids`	String	No	An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
`Zuora-Org-Ids`	String	No	Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
`Accept-Encoding`	String	No	Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.

Request body fields

Name	Type	Required	Description
`accountNumber`	String	No	The account number for which the delivery adjustment is created. Note: The account number should be of the subscription owner. Only one of accountNumber or subscriptionNumber should be provided.
`recognizedRevenueAccountingCode`	String	No	The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. Note: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge.
`endDate`	String	Yes	The end date of the delivery adjustment, in `yyyy-mm-dd` format. This is inclusive.
`exclusion[]`	Array	No	The charge numbers and the corresponding dates for exclusion of delivery adjustment.
`exclusion[].chargeNumbers[]`	Array	No	The charge numbers to be excluded from delivery adjustment on the specified delivery date.
`exclusion[].deliveryDate`	String	No	The date on which the delivery adjustment has to be excluded, in `yyyy-mm-dd` format.
`chargeNumbers[]`	Array	No	An optional container to specify charge numbers in the subscription for which the delivery adjustment needs to be created.
`revenueRecognitionRuleName`	String	No	The name of the revenue recognition rule governing the revenue schedule. Note: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge.
`subscriptionNumber`	String	No	The subscription number for which the delivery adjustment is created. Note: Only one of accountNumber or subscriptionNumber should be provided.
`type`	String	No	The type of delivery adjustment. Possible values: `"DeliveryCredit"`
`startDate`	String	Yes	The start date of the delivery adjustment, in `yyyy-mm-dd` format. This is inclusive.
`reason`	String	No	The reason for the delivery adjustment.
`deferredRevenueAccountingCode`	String	No	The accounting code for the deferred revenue, such as Monthly Recurring Liability. Note: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.