---
title: "Add billing automation payment plan"
method: POST
path: "/api/connector/v1/billingAutomationPaymentPlans/add"
tags: ["Payment plans"]
---

# Add billing automation payment plan

`POST /api/connector/v1/billingAutomationPaymentPlans/add`

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](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).

## Request body

- BillingAutomationPaymentPlanAddParameters
  - `ClientToken` string, required — Token identifying the client application.
  - `AccessToken` string, required — Access token of the client application.
  - `Client` string, required — Name and version of the client application.
  - `EnterpriseId` string, uuid, nullable — Unique identifier of the enterprise. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
  - `BillingAutomationId` string, uuid, required — Unique identifier of the `Billing automation` associated with the payment plan.
  - `CustomerId` string, uuid, required — Unique identifier of the `Customer` associated with the payment plan.
  - `Name` string, required — Name of the payment plan.
  - `PaymentRequest` BillingAutomationPaymentPlanPaymentRequest, required
    - `PaymentMethods` PaymentMethodsEnum[], required — Allowed payment methods to use for the payment plan. Currently only `Payment card` and `SEPA Direct Debit` are supported.
    - `Message` string, required — Message for customer in the payment request email.
    - `Note` string, nullable — Internal note for the payment request.
    - `ExpirationDateUtc` string, date-time, required — Expiration date (UTC time) of the payment request. Must be within 30 days of payment plan creation. ISO-8601 format.
    - `SendEmail` boolean, required — Specifies whether a payment request email is sent to the customer.
  - `PaymentOffsetDays` integer, required — Number of days since the bill creation when the payment will be charged.
  - `StartMonth` string, 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 `200`

OK

- PaymentPlanAddResult
  - `PaymentRequestUrl` string, required — Payment request URL associated with the created payment plan.

## Other responses

- `204` — Server has successfully fulfilled the request and there is no additional information to send back.
- `400` — Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
- `401` — Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
- `403` — Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
- `408` — Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
- `429` — Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
- `500` — Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).

---

[API](https://skmtc.net/mews/apis/connector-api.md) · [All operations](https://skmtc.net/mews/apis/connector-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mews/connector-api/revisions/4bf95cbc375f/schema)