GET
/
Subscription
/
{subId}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/Subscription/{subId} \
  --header 'requestToken: <api-key>'
{
  "IdSub": 396,
  "Method": "card",
  "PaypointId": 255,
  "TotalAmount": 103,
  "NetAmount": 3762.87,
  "FeeAmount": 3,
  "PaymentData": {
    "MaskedAccount": "4XXXXXXXX1111",
    "AccountType": "visa",
    "AccountExp": "11/29",
    "AccountZip": "90210",
    "HolderName": "Chad Mercia",
    "orderDescription": "Depost for materials for 123 Walnut St",
    "StoredId": "1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440",
    "Initiator": "payor",
    "StoredMethodUsageType": "subscription",
    "Sequence": "subsequent",
    "accountId": "<string>",
    "SignatureData": null,
    "binData": {
      "binMatchedLength": 6,
      "binCardBrand": "Visa",
      "binCardType": "Credit",
      "binCardCategory": "PLATINUM",
      "binCardIssuer": "Bank of Example",
      "binCardIssuerCountry": "United States",
      "binCardIssuerCountryCodeA2": "US",
      "binCardIssuerCountryNumber": 840
    },
    "paymentDetails": {
      "totalAmount": 100,
      "serviceFee": 0,
      "currency": "USD",
      "checkNumber": "107",
      "checkImage": {},
      "categories": [
        {
          "label": "Deposit",
          "description": "Deposit for materials",
          "amount": 1000,
          "qty": 1
        }
      ],
      "splitFunding": [
        {
          "recipientEntryPoint": "41035afaa7",
          "accountId": "187-782",
          "description": "Split for annual dues",
          "amount": 456.23
        }
      ]
    }
  },
  "StartDate": "2025-10-19T00:00:00",
  "EndDate": "2025-10-19T00:00:00",
  "NextDate": "2025-10-19T00:00:00",
  "Frequency": "monthly",
  "TotalCycles": 24,
  "LeftCycles": 15,
  "LastRun": "2025-10-19T00:00:00",
  "SubStatus": 1,
  "EntrypageId": 0,
  "PlanId": 0,
  "UntilCancelled": true,
  "SubEvents": [
    {
      "description": "TransferCreated",
      "eventTime": "2023-07-05T22:31:06.8317486+00:00",
      "refData": "<string>",
      "extraData": {},
      "source": "api"
    }
  ],
  "LastUpdated": "2022-07-01 15:00:01",
  "Customer": {
    "CustomerId": 4440,
    "FirstName": "John",
    "LastName": "Doe",
    "CompanyName": "Sunshine LLC",
    "CustomerNumber": "3456-7645A",
    "BillingAddress1": "1111 West 1st Street",
    "BillingAddress2": "Suite 200",
    "BillingCity": "Miami",
    "BillingState": "FL",
    "BillingZip": "45567",
    "BillingCountry": "US",
    "BillingPhone": "5555555555",
    "BillingEmail": "example@email.com",
    "ShippingAddress1": "123 Walnut St",
    "ShippingAddress2": "STE 900",
    "ShippingCity": "Johnson City",
    "ShippingState": "TN",
    "ShippingZip": "37619",
    "ShippingCountry": "US",
    "AdditionalData": {
      "key1": "value1",
      "key2": "value2",
      "key3": "value3"
    },
    "CreatedAt": "2022-07-01 15:00:01",
    "customerId": 4440,
    "customerStatus": 1,
    "Identifiers": [
      "\\\"firstname\\\"",
      "\\\"lastname\\\"",
      "\\\"email\\\"",
      "\\\"customId\\\""
    ]
  },
  "InvoiceData": {
    "invoiceNumber": "INV-2345",
    "invoiceDate": "2024-07-01",
    "invoiceDueDate": "2024-07-01",
    "invoiceType": 0,
    "invoiceEndDate": "2024-07-01",
    "invoiceStatus": 1,
    "frequency": "monthly",
    "paymentTerms": "PIA",
    "termsConditions": "Must be paid before work scheduled.",
    "notes": "Example notes.",
    "tax": 2.05,
    "discount": 10,
    "invoiceAmount": 105,
    "freightAmount": 10,
    "dutyAmount": 0,
    "purchaseOrder": "PO-345",
    "firstName": "Chad",
    "lastName": "Mercia",
    "company": "ACME, INC",
    "shippingAddress1": "123 Walnut St",
    "shippingAddress2": "STE 900",
    "shippingCity": "Johnson City",
    "shippingState": "TN",
    "shippingZip": "37619",
    "shippingCountry": "US",
    "shippingEmail": "example@email.com",
    "shippingPhone": "5555555555",
    "shippingFromZip": "30040",
    "summaryCommodityCode": "501718",
    "items": [
      {
        "itemProductCode": "M-DEPOSIT",
        "itemProductName": "Materials deposit",
        "itemDescription": "Deposit for materials.",
        "itemCommodityCode": "010",
        "itemUnitOfMeasure": "SqFt",
        "itemCost": 5,
        "itemQty": 1,
        "itemMode": 0,
        "itemCategories": [
          "<string>"
        ],
        "itemTotalAmount": 123,
        "itemTaxAmount": 7,
        "itemTaxRate": 0.075
      }
    ],
    "attachments": {},
    "AdditionalData": {
      "key1": "value1",
      "key2": "value2",
      "key3": "value3"
    }
  },
  "PaypointLegalname": "Sunshine Services, LLC",
  "PaypointDbaname": "Sunshine Gutters",
  "PaypointEntryname": "d193cf9a46",
  "ParentOrgName": "PropertyManager Pro",
  "CreatedAt": "2022-07-01 15:00:01",
  "ExternalPaypointID": "Paypoint-100",
  "Source": "api"
}

Authorizations

requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

subId
integer
required

The subscription ID.

Example:

231

Response

200
application/json
Success
IdSub
integer

The subscription's ID.

Example:

396

Method
string | null

The subscription's payment method.

Example:

"card"

PaypointId
integer | null

The paypoint's ID. Note that this is different than the entryname.

Example:

255

TotalAmount
number | null

The subscription amount, including any fees.

Example:

103

NetAmount
number | null

The subscription amount, minus any fees.

Example:

3762.87

FeeAmount
number | null

Fee applied to the subscription.

Example:

3

PaymentData
object
StartDate
string | null

The subscription start date.

Example:

"2025-10-19T00:00:00"

EndDate
string | null

The subscription's end date.

Example:

"2025-10-19T00:00:00"

NextDate
string | null

The next date the subscription will be processed.

Example:

"2025-10-19T00:00:00"

Frequency
string | null

The subscription's frequency.

Example:

"monthly"

TotalCycles
integer | null

The total number of cycles the subscription is set to run.

Example:

24

LeftCycles
integer | null

The number of cycles the subscription has left.

Example:

15

LastRun
string | null

The last time the subscription was processed.

Example:

"2025-10-19T00:00:00"

SubStatus
integer | null

The subscription's status.

  • 0: Paused
  • 1: Active
Example:

1

EntrypageId
integer

If applicable, the internal reference ID to the payment page capturing the payment.

Example:

0

PlanId
integer

Payment plan ID.

Example:

0

UntilCancelled
boolean

When true, the subscription has no explicit end date and will run until canceled.

Example:

true

SubEvents
object[] | null

Events associated with the subscription.

LastUpdated
string | null

The last date and time the subscription was updated.

Example:

"2022-07-01 15:00:01"

Customer
object
InvoiceData
object
PaypointLegalname
string | null

The paypoint's legal name.

Example:

"Sunshine Services, LLC"

PaypointDbaname
string | null

The paypoint's DBA name.

Example:

"Sunshine Gutters"

PaypointEntryname
string | null

The paypoint's entryname.

Maximum length: 50
Example:

"d193cf9a46"

ParentOrgName
string | null

The name of the parent organization.

Example:

"PropertyManager Pro"

CreatedAt
string

Timestamp of when the subscription ws created, in UTC.

Example:

"2022-07-01 15:00:01"

ExternalPaypointID
string | null

A custom identifier for the paypoint, if applicable. Like entrypoint is the Payabli identifier for the merchant, externalPaypointId is a custom field you can use to include the merchant's ID from your own systems.

Example:

"Paypoint-100"

Source
string | null

Custom identifier to indicate the transaction or request source.

Maximum length: 100
Example:

"api"