Get payout subscription

from payabli import payabli
client = payabli(
    api_key="YOUR_API_KEY_HERE",
)
client.payout_subscription.get_payout_subscription(
    id=42,
)

{
  "responseText": "Success",
  "isSuccess": true,
  "responseData": {
    "startDate": "2025-09-01T00:00:00Z",
    "endDate": "2026-09-01T00:00:00Z",
    "nextDate": "2025-10-01T00:00:00Z",
    "lastRun": "2025-09-01T06:00:00Z",
    "idOutSubscription": 42,
    "status": 1,
    "events": [
      {
        "description": "TransferCreated",
        "eventTime": "2025-09-01T06:00:00Z",
        "extraData": {
          "key": "value"
        },
        "refData": "refData",
        "source": "api"
      }
    ],
    "vendor": {
      "Address1": "123 Ocean Drive",
      "Address2": "Suite 400",
      "BillingData": {
        "id": 123456,
        "nickname": "Main Checking Account",
        "bankName": "Example Bank",
        "routingAccount": "123456789",
        "accountNumber": "9876543210",
        "typeAccount": "Checking",
        "bankAccountHolderName": "John Doe",
        "bankAccountHolderType": "Business",
        "bankAccountFunction": 2,
        "verified": true,
        "status": 1,
        "services": [],
        "default": true,
        "accountId": "bank-account-001"
      },
      "City": "Bristol",
      "Contacts": {
        "ContactEmail": "eric@martinezcoatings.com",
        "ContactName": "Eric Martinez",
        "ContactPhone": "5555555555",
        "ContactTitle": "Owner"
      },
      "Country": "US",
      "CreatedDate": "2022-07-01T15:00:01Z",
      "customerVendorAccount": "123-456",
      "customField1": "",
      "customField2": "",
      "EIN": "123456789",
      "Email": "example@email.com",
      "externalPaypointID": "Paypoint-100",
      "InternalReferenceId": 1000000,
      "LastUpdated": "2022-07-01T15:00:01Z",
      "LocationCode": "LOC123",
      "Mcc": "7777",
      "Name1": "Herman's Coatings",
      "Name2": "Herman's Coating Supply Company, LLC",
      "ParentOrgName": "PropertyManager Pro",
      "ParentOrgId": 1000,
      "payeeName1": "payeeName1",
      "payeeName2": "payeeName2",
      "PaypointDbaname": "Sunshine Gutters",
      "PaypointEntryname": "d193cf9a46",
      "PaypointLegalname": "Sunshine Services, LLC",
      "Phone": "2125551234",
      "remitAddress1": "123 Walnut Street",
      "remitAddress2": "Suite 900",
      "remitCity": "Miami",
      "remitCountry": "US",
      "remitState": "FL",
      "remitZip": "31113",
      "State": "GA",
      "StoredMethods": [],
      "Summary": {
        "ActiveBills": 2,
        "PendingBills": 4,
        "InTransitBills": 3,
        "PaidBills": 18,
        "OverdueBills": 1,
        "ApprovedBills": 5,
        "DisapprovedBills": 1,
        "TotalBills": 34,
        "ActiveBillsAmount": 1250.75,
        "PendingBillsAmount": 2890.5,
        "InTransitBillsAmount": 1675.25,
        "PaidBillsAmount": 15420.8,
        "OverdueBillsAmount": 425,
        "ApprovedBillsAmount": 3240.9,
        "DisapprovedBillsAmount": 180,
        "TotalBillsAmount": 25083.2
      },
      "VendorId": 1,
      "VendorNumber": "1234",
      "VendorStatus": 1,
      "Zip": "31113"
    },
    "billData": [
      {
        "dueDate": "2025-08-15",
        "invoiceDate": "2025-08-01",
        "billId": 3001,
        "invoiceNumber": "INV-5001",
        "netAmount": "500"
      }
    ],
    "externalPaypointID": "d193cf9a46-10",
    "method": "ach",
    "paypointId": 255,
    "totalAmount": 500,
    "netAmount": 500,
    "feeAmount": 0,
    "paymentData": {
      "AccountType": "checking",
      "HolderName": "Herman Coatings",
      "Initiator": "merchant",
      "MaskedAccount": "XXXXXX5666",
      "paymentDetails": {
        "totalAmount": 500,
        "currency": "USD",
        "serviceFee": 0
      },
      "Sequence": "subsequent",
      "StoredMethodUsageType": "recurring"
    },
    "frequency": "monthly",
    "totalCycles": 12,
    "leftCycles": 11,
    "entrypageId": 0,
    "untilCancelled": false,
    "lastUpdated": "2025-08-01T12:00:00Z",
    "createdAt": "2025-08-01T12:00:00Z",
    "paypointLegalname": "Sunshine Services, LLC",
    "paypointDbaname": "Sunshine Gutters",
    "paypointEntryname": "d193cf9a46",
    "parentOrgName": "PropertyManager Pro",
    "parentOrgId": 236,
    "source": "api"
  }
}

Retrieves a single payout subscription’s details. See Manage payout subscriptions for more information.

Authentication

requestTokenstring

API Key authentication via header

Path parameters

idlongRequired

The payout subscription ID.

Response

Success

responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

isSuccessboolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

responseDataobject

The payout subscription record.

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error