***

title: Manage payout subscriptions with the API
subtitle: >-
Learn how to create, update, and delete automated recurring payouts to vendors
with the Payabli API
description: >-
Automate recurring vendor payouts with the payout subscription API. Create,
update, pause, and delete payout subscriptions with full control over
frequency and amounts
'og:description': >-
Automate recurring vendor payouts with the payout subscription API. Create,
update, pause, and delete payout subscriptions with full control over
frequency and amounts
keywords: >-
embedded payments, payment API, REST API, payment processing, payouts,
recurring payouts, payout subscription, autopay, scheduled payouts, vendor
payments
slug: guides/pay-out-developer-payout-subscriptions-manage
icon: calendar-plus
area:

* Pay Out
  subArea:
* Subscriptions and Autopays
  audience:
* developers

***

<AudienceInfo audiences={['developers']} />

Payout subscriptions are bill pay on autopilot. You set the vendor, amount, payment method, and frequency, and the system runs it on schedule. Supported payment methods are ACH, vCard, and check. Each payout goes through the same batching and funding flow as a manual payout.

This is useful any time you're paying the same vendor the same amount on a regular cadence. Common examples include property management companies paying owners their rent share every month, recurring contractor payments, commissions, or regular vendor bills.

This guide covers the key operations for managing payout subscriptions through the API.

## Considerations

When working with payout subscriptions, keep the following in mind:

* Payout subscriptions are linked to a vendor. Pass a `vendorId` or `vendorNumber` in the `vendorData` object to associate the subscription with an existing vendor.
* The `billData` array is optional. If you omit it and don't set `doNotCreateBills` to `true`, the system creates a bill automatically.
* The `paymentMethod` object supports `ach`, `vcard`, and `check` methods. The `managed` method isn't supported for payout subscriptions.
* Payout subscription transactions typically run between 2:30 AM and 3:30 AM Eastern time.

## Create a payout subscription

Send a POST request to `/api/PayoutSubscription` to create a new payout subscription. See the [API reference](/developers/api-reference/payout-subscription/create-payout-subscription) for full documentation.

<Tabs>
  <Tab title="ACH payout subscription">
    Creates a recurring payout subscription using ACH bank transfer.

    <EndpointRequestSnippet endpoint="POST /api/PayoutSubscription" example="ACHPayoutSubscription" />
  </Tab>

  <Tab title="vCard payout subscription">
    Creates a recurring payout subscription using a virtual card.

    <EndpointRequestSnippet endpoint="POST /api/PayoutSubscription" example="VcardPayoutSubscription" />
  </Tab>
</Tabs>

A successful request returns the payout subscription ID in `responseData` and the vendor's ID in `customerId`.

<EndpointResponseSnippet endpoint="POST /api/PayoutSubscription" example="ACHPayoutSubscription" />

## Pause a payout subscription

Pausing a payout subscription stops all future payouts until you unpause it. The next payment date isn't calculated automatically while paused.

To pause a payout subscription, send a PUT request to `/api/PayoutSubscription/{id}` with `setPause` set to `true`. To resume, send another PUT request with `setPause` set to `false`.

<Tabs>
  <Tab title="Pause">
    <EndpointRequestSnippet endpoint="PUT /api/PayoutSubscription/{id}" example="PausePayoutSubscription" />
  </Tab>

  <Tab title="Unpause">
    <EndpointRequestSnippet endpoint="PUT /api/PayoutSubscription/{id}" example="UnpausePayoutSubscription" />
  </Tab>
</Tabs>

## Get payout subscription details

Send a GET request to `/api/PayoutSubscription/{id}` to retrieve details about a specific payout subscription.

This example gets the details for the payout subscription with ID `42`.

<EndpointRequestSnippet endpoint="GET /api/PayoutSubscription/{id}" example="GetPayoutSubscription" />

A successful request returns all available details about the payout subscription. See the [API reference](/developers/api-reference/payout-subscription/get-payout-subscription) for a full response example.

<EndpointResponseSnippet endpoint="GET /api/PayoutSubscription/{id}" example="GetPayoutSubscription" />

## Update a payout subscription

Send a PUT request to `/api/PayoutSubscription/{id}` to change an existing payout subscription's payment details, schedule, or payment method. See the [API reference](/developers/api-reference/payout-subscription/update-payout-subscription) for full documentation.

<EndpointRequestSnippet endpoint="PUT /api/PayoutSubscription/{id}" example="UpdatePayoutSubscription" />

A successful request returns the payout subscription ID in `responseData` and the vendor's ID in `customerId`.

<EndpointResponseSnippet endpoint="PUT /api/PayoutSubscription/{id}" example="UpdatePayoutSubscription" />

## Delete a payout subscription

Send a DELETE request to `/api/PayoutSubscription/{id}` to cancel a payout subscription and stop future payouts. See the [API reference](/developers/api-reference/payout-subscription/delete-payout-subscription) for full documentation.

This example deletes the payout subscription with the ID `42`.

<EndpointRequestSnippet endpoint="DELETE /api/PayoutSubscription/{id}" example="DeletePayoutSubscription" />

A successful deletion returns a response that includes the payout subscription ID (in `responseData`).

<EndpointResponseSnippet endpoint="DELETE /api/PayoutSubscription/{id}" example="DeletePayoutSubscription" />

## Related resources

See these related resources to help you get the most out of Payabli.

<AccordionGroup>
  <Accordion title="Prerequisites">
    * **[Manage vendors with the API](/guides/pay-out-developer-vendors-manage)** - Payout subscriptions are linked to a vendor, so you need to understand vendors first
  </Accordion>

  <Accordion title="References">
    * **[Pay Out schemas](/guides/pay-out-schemas-overview)** - Learn about money out statuses and events and how they work together
    * **[Pay Out statuses](/guides/pay-out-status-reference)** - Learn about Pay Out statuses
  </Accordion>

  <Accordion title="Related topics">
    * **[Manage payouts with the API](/guides/pay-out-developer-payouts-manage)** - Learn how to use the Payabli API to create, capture, and cancel payout transactions
    * **[Manage bills with the API](/guides/pay-out-developer-bills-manage)** - Learn how to add and manage bills for vendors via the API
  </Accordion>

  <Accordion title="Often confused with">
    **Manage subscriptions with the API** - Pay In subscriptions collect payments from customers, payout subscriptions send payments to vendors See [Manage subscriptions with the API](/guides/pay-in-developer-subscriptions-manage)
  </Accordion>
</AccordionGroup>