Retrieve a payment schedule

GET

/object-query/payment-schedules/:key

GET

/object-query/payment-schedules/:key

from zuora import ZuoraClient
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.object_queries.query_payment_schedule_by_key(
    key="key",
    fields_array=[
        "id,createddate"
    ],
)

{
  "id": "8ad08e1a8625517601862f5c50dc21a7",
  "createdById": "2c92c09467cada0a0167cc79e59c0884",
  "createdDate": "2023-02-07T20:50:24-08:00",
  "updatedById": "2c92c09467cada0a0167cc79e59c0884",
  "updatedDate": "2023-02-07T20:50:42-08:00",
  "number": "PS-00000002",
  "accountId": "2c92c0f86ac39714016ad3e985c270c8",
  "invoiceId": "8ad098887fd49533017fde9722806ac9",
  "startDate": "2025-02-09",
  "runHour": 2,
  "period": "Weekly",
  "prepayment": false,
  "occurrences": 3,
  "status": "Active",
  "description": "Payment Schedule 1",
  "totalPaymentsProcessed": 0,
  "totalPaymentsErrored": 0,
  "totalAmount": 0
}

Retrieve the details of a specific Payment Schedule object.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Path parameters

keystringRequired

Object ID or Number.

Headers

Content-EncodingstringOptional

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-Org-IdsstringOptional

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

Query parameters

pageSizeintegerOptional1-99Defaults to 10

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.

cursorstringOptional

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[]list of stringsOptional

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[]list of stringsOptional

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[]list of stringsOptional

A case-insensitive filter on the list.

fields[]list of stringsOptional

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

includeNullFieldsbooleanOptionalDefaults to false

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.

Response headers

Content-EncodingstringOptional

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

application/json
application/xml
text/html
text/csv
text/plain

RateLimit-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-IdstringOptional

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-IdstringOptional

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Concurrency-Limit-TypestringOptional

The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query.

For more information, see Concurrent request limits.

Concurrency-Limit-Limitinteger

The total number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Concurrency-Limit-Remaininginteger

The remaining number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Response

idstringOptional

The unique identifier of the payment schedule.

createdByIdstringOptional

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

createdDatedatetimeOptional

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

updatedByIdstringOptional

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

updatedDatedatetimeOptional

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

numberstringOptional

Number of the payment schedule.

accountIdstringOptional

ID of the account that owns the payment schedule.

invoiceIdstringOptional

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

debitmemoIdstringOptional

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

paymentOptionIdstringOptional

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

startDatedateOptional

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

runHourintegerOptional0-23

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.

periodenum or nullOptional

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

Returns null for custom payment schedules.

Allowed values:

prepaymentbooleanOptional

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.

occurrencesintegerOptional

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

statusenumOptional

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.

Allowed values:

descriptionstringOptional

The description of the payment schedule.

nextPaymentDatedateOptional

The date the next payment will be processed.

recentPaymentDatedateOptional

The date the last payment was processed.

totalPaymentsProcessedintegerOptional

The number of processed payments.

totalPaymentsErroredintegerOptional

The number of errored payments.

totalAmountdoubleOptional

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

Errors

4XX

Client Request Error

500

Internal Server Error