Generate subscription booklet

Generates the PDF booklet of a subscription.

Use this operation to get the payments linked to the recurrence in a single document.

⚠️

Sandbox behavior

In Sandbox, generating the booklet may also bring forward the creation of the subscription's future payments up to the period defined by month and year.

The payments created are available for querying, but no payment is made by this operation.

See how to generate new payments for a subscription.

Payments created during this process have their own financial cycle and may trigger the corresponding payment events.

Related content

Guides

Path Params
string
required

Unique subscription identifier in Asaas

Query Params
integer

Final month for generating the booklet

integer

Final year for generating the booklet

string

Filter by column name

string

Column ordering

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

403

Forbidden. Occurs when the request body is filled, GET method calls must have an empty body.

404

Not found

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/pdf
application/json