Generate billing documents for an account

Request

Creates billing documents for an account.

Security

bearerAuth

Path

account_idstringrequired

Identifier for the account, either account_number or account_id

zuora-track-idstring

A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your 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 ("), or quote (').

asyncboolean

Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID.

Default:false

zuora-entity-idsstring

An entity ID. If you have Multi-entity enabled and the authorization token is valid for more than one entity, you must use this header to specify which entity to perform the operation on. If the authorization token is only valid for a single entity or you do not have Multi-entity enabled, you do not need to set this header.

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. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see Idempotent Requests.

accept-encodingstring

Include a accept-encoding: gzip header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see Request and Response Compression.

content-encodingstring

Include a content-encoding: gzip header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see Request and Response Compression.

Bodyapplication/jsonrequired

postboolean

If true, invoices will be automatically posted.

Example:true

renewboolean

If true, subscriptions will be automatically renewed.

Example:true

charges_excludedArray of strings

Charge type or types to be excluded. Can be one or multiple of the following values:

one_time
recurring
usage

credit_memo_reason_codestring

A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code.

document_datestring, (date)

The date when the credit memo is applied

Example:"2023-01-01"

subscription_idsArray of strings

The IDs of the subscriptions that you want to create the billing documents for. Each value must be the unique identifier of the latest version of an active subscription.

target_datestring, (date)

All unbilled items on or before this date are included.

Example:"2023-01-01"

{
  "target_date": "2023-12-01",
  "subscription_ids": [
    "8ad0940886748c1501867a78a9444790",
    "8ad08cbd86747d0801867a7a7f8445a4"
  ],
  "document_date": "2023-02-21"
}

Responses

Default Response

Headers

ratelimit-limitstring

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

ratelimit-remainingnumber

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

ratelimit-resetnumber

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

zuora-request-idstring

Zuora’s internal identifier for this request.

zuora-track-idstring

A user-supplied identifier for this request. If you supply a zuora-track-id as a request header, Zuora returns the zuora-track-id as a response header.

Bodyapplication/json

credit_memosobject(CreditMemoListResponse)

Array of credit memos.

invoicesobject(InvoiceListResponse)read-only

Array of invoices.

Response

{
  "invoices": {
    "next_page": null,
    "data": [ … ]
  }
}