Create Installment

post

https://api-sandbox.asaas.com/v3/installments

Creates an installment plan for a customer in Asaas.

Use this operation to directly create an installment plan with two or more installments. In this route, value represents the value of each installment; the installmentValue field, used in the installment flow via /v3/payments, is not part of the POST /v3/installments contract.

⚠️
One-time payment
Do not use this endpoint for single-installment payments.
Create the payment through Create new payment.

Each payment generated by the installment has its own lifecycle. Use the payment Webhooks to track payments and subsequent status changes.

Related content

Guides

Body Params

installmentCount

int32

required

Number of installments

customer

string

required

Unique customer identifier in Asaas

value

number

required

Value of each installment

totalValue

number

Total installment amount

billingType

string

enum

required

Payment billing type

Allowed:

dueDate

date

required

Due date of the first installment

description

string

Installment description (max. 500 characters)

postalService

boolean

Define whether the payment will be sent via post

daysAfterDueDateToRegistrationCancellation

int32

Days after registration cancellation deadline (only for bank slip)

paymentExternalReference

string

Free search field

discount

object

Discount information

interest

object

Interest information for payment after due date

fine

object

Fine information for payment after due date

splits

array of objects

Split Settings

splits

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json