Sign in

v3

latestOpenAPI 3.0.42026-07-312008682.1 MB
Payment plans

Add billing automation payment plan

Adds a payment plan connected to a Billing automation and returns the payment request URL associated with the created payment plan. The fulfillment of the payment request will activate the payment plan. Note this operation supports Portfolio Access Tokens.

post/api/connector/v1/billingAutomationPaymentPlans/add

Request body

ClientTokenstring required

Token identifying the client application.

AccessTokenstring required

Access token of the client application.

Clientstring required

Name and version of the client application.

EnterpriseIdstring uuid nullable

Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise.

BillingAutomationIdstring uuid required

Unique identifier of the Billing automation associated with the payment plan.

CustomerIdstring uuid required

Unique identifier of the Customer associated with the payment plan.

Namestring required

Name of the payment plan.

PaymentOffsetDaysinteger required

Number of days since the bill creation when the payment will be charged.

StartMonthstring nullable

Specifies the month when the payment plan begins collecting payments, in the 'YYYY-MM' format. The month must be in the future. If a value is not set, it'll start with the earliest available bill created from billing automation.

Response

OK

PaymentRequestUrlstring required

Payment request URL associated with the created payment plan.