Sign in
Object Queries

Retrieve a payment schedule

Retrieve the details of a specific Payment Schedule object.

get/object-query/payment-schedules/{key}

Path parameters

keystring required

Object ID or Number.

Query parameters

pageSizeinteger

The maximum number of results to return in a single page. If the specified pageSize is less than 1 or greater than 99, Zuora will return a 400 error.

cursorstring

A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with next_page=W3sib3JkZXJ=, your subsequent call can include cursor=W3sib3JkZXJ= in order to fetch the next page of the list.

sort[]string[]

A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. accountnumber.ASC) or descending (e.g. accountnumber.DESC). You cannot sort on properties in arrays. If the array-type properties are specified for the sort[] parameter, they are ignored.

expand[]string[]

Allows you to expand responses by including related object information in a single call. The Payment Schedule object does not support expanding any related objects.

filter[]string[]

A case-insensitive filter on the list.

fields[]string[]

A case-insensitive query parameter that allows you to specify which fields are returned in the response.

includeNullFieldsboolean

Specifies whether to include fields with the null value in the response.

  • If set to true, all fields will be returned in the response, including those with the null value.
  • If set to false, only fields with non-null values will be returned.

Headers

Idempotency-Keystring

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.

Accept-Encodingstring

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-Encodingstring

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-Idstring

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-Idsstring

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-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> 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. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Response

OK

idstring

The unique identifier of the payment schedule.

createdByIdstring

The unique identifier of the user who created the payment schedule.

createdDatestring date-time

The time that the payment schedule gets created in the system, in the YYYY-MM-DD HH:MM:SS format.

updatedByIdstring

The unique identifier of the user who last updated the payment schedule.

updatedDatestring date-time

The time that the payment schedule gets updated in the system, in the YYYY-MM-DD HH:MM:SS format.

numberstring

Number of the payment schedule.

accountIdstring

ID of the account that owns the payment schedule.

invoiceIdstring

The unique identifier of the invoice to which the payment is applied.

debitmemoIdstring

The unique identifier of the debit memo to which the payment is applied.

paymentOptionIdstring

The unique identifier of the payment option that is used to process the payment schedule.

startDatestring date

The date when the first payment of this payment schedule is proccessed.

runHourinteger

At which hour in the day in the tenant’s timezone the recurring payment schedule items will be collected.

Return 0 for custom payment schedules.

period'Monthly' | 'Weekly' | 'BiWeekly' | 'null' nullable

For recurring payment schedule only. The period of payment generation.

Returns null for custom payment schedules.

prepaymentboolean

Indicates whether the payments created by the payment schedule are used as a reserved payment. This field is available only if the prepaid cash drawdown permission is enabled. See Prepaid Cash with Drawdown for more information.

occurrencesinteger

The number of payment schedule items that are created by this payment schedule.

status'Active' | 'Canceled' | 'Completed'

The status of the payment schedule.

  • Active: There is still payment schedule item to process.

  • Canceled: After a payment schedule is canceled by the user, the schedule is marked as canceled.

  • Completed: After all payment schedule items are processed, the schedule is marked as Completed.

descriptionstring

The description of the payment schedule.

nextPaymentDatestring date

The date the next payment will be processed.

recentPaymentDatestring date

The date the last payment was processed.

totalPaymentsProcessedinteger

The number of processed payments.

totalPaymentsErroredinteger

The number of errored payments.

totalAmountnumber

The total amount that will be collected by the payment schedule.

Changes