Detach charges from an invoice schedule

Detaches charges from an invoice schedule. The invoice schedules you want to detach charges from must be in Fully Processed or Partially Processed status. Invoice schedules do not bill detached charges.

SecuritybearerAuth

Request

path Parameters

scheduleKey

required

string

The unique ID or number of the invoice schedule to detach charges from. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.

header Parameters

Accept-Encoding	string 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.
Content-Encoding	string 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 <= 64 characters 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 (`'`).
Zuora-Entity-Ids	string 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 should not set this header.
Zuora-Org-Ids	string 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.

Request Body schema: application/json
required

Array of objects (specificSubscriptions)

A list of charge numbers to be detached from the invoice schedule.

Each item in this array represents a specific subscription associated with the invoice schedule. Use the chargeNumbers field to specify all the charges you want to detach for each subscription.

Responses

200

500

Internal Server Error

4XX

Request Errors

put/v1/invoice-schedules/{scheduleKey}/detach

Request samples

Payload
cURL

application/json

{"specificSubscriptions": [{"orderKey": "O-00017019",
"subscriptionKey": "A-S00008953",
"chargeNumbers": ["C-00065317"
]
}
]
}

Response samples

application/json

{"success": true
}