How to determine if a customer has an active recurring payment?

[r-brown]

Question

How to determine if a customer has an active recurring payment?

[r-brown]

Retrieving Customer Shop Transactions Using Transaction Service

All customer shop transactions are stored as Transaction entities and can be retrieved using the Transaction Service list operation.

A filter feature is available, allowing additional filtering for the list() operations, e.g.

... filter all Shop only transactions list by licenseeNumber
/transaction?filter=licenseeNumber=<VALUE>;shopOnly=true;page=0

Sample (demo:demo account)

... filter all Shop only transactions list by licenseeNumber

curl -X GET --header 'Accept: application/xml' --header 'Authorization: Basic ZGVtbzpkZW1v' 'https://go.netlicensing.io/core/v2/rest/transaction?filter=licenseeNumber=c021bd5b-2ab8-49d7-9e6c-29b4353f4791;shopOnly=true;page=0' | xmllint --format -

Identifying a Specific Transaction and Related Licenses

In the returned list of transactions, a specific transaction can be identified using its number and/or recurring attributes.

Additional transaction properties provide context, including: status, grandTotal, paymentMethod, licenseeNumber, etc.

Sample Transaction Entity:

{
    "property": [
        {
            "value": "T6RSJPEM5",
            "name": "number"
        },
        {
            "value": "false",
            "name": "active"
        },
        {
            "value": "CLOSED",
            "name": "status"
        },
        {
            "value": "SHOP",
            "name": "source"
        },
        {
            "value": "7.00",
            "name": "grandTotal"
        },
        {
            "value": "0.00",
            "name": "discount"
        },
        {
            "value": "EUR",
            "name": "currency"
        },
        {
            "value": "2025-03-24T13:31:14.190Z",
            "name": "datecreated"
        },
        {
            "value": "2025-03-24T13:31:14.190Z",
            "name": "dateclosed"
        },
        {
            "value": "true",
            "name": "inUse"
        },
        {
            "value": "GROSS",
            "name": "vatMode"
        },
        {
            "value": "7.00",
            "name": "totalExcludingVat"
        },
        {
            "value": "true",
            "name": "recurring"
        },
        {
            "value": "false",
            "name": "isSubjectToVat"
        },
        {
            "value": "false",
            "name": "isReverseCharge"
        },
        {
            "value": "c021bd5b-2ab8-49d7-9e6c-29b4353f4791",
            "name": "bundleNumber"
        },
        {
            "value": "7",
            "name": "subTotal"
        },
        {
            "value": "0",
            "name": "vatPercent"
        },
        {
            "value": "https://en.wikipedia.org/wiki/North_Pole#terms",
            "name": "consentTermsOfServiceURL"
        },
        {
            "value": "2025-03-17T12:33:36.185Z",
            "name": "consentTimestamp"
        },
        {
            "value": "0.00",
            "name": "vatAmount"
        },
        {
            "value": "pm_1R3creBoOqLD4J3wG6TobA4Z",
            "name": "stripePaymentMethodId"
        },
        {
            "value": "STRIPE_TESTING",
            "name": "paymentMethodNumber"
        },
        {
            "value": "DE",
            "name": "vendorCountryCode"
        },
        {
            "value": "BW",
            "name": "countryCode"
        },
        {
            "value": "STRIPE_TESTING",
            "name": "paymentMethod"
        },
        {
            "value": "ECQYWPFUK",
            "name": "licenseTemplateNumber"
        },
        {
            "value": "https://en.wikipedia.org/wiki/North_Pole#privacy",
            "name": "consentPrivacyPolicyURL"
        },
        {
            "value": "cus_RxXxFsHlM1u54F",
            "name": "stripeCustomerId"
        },
        {
            "value": "c021bd5b-2ab8-49d7-9e6c-29b4353f4791",
            "name": "bundle"
        },
        {
            "value": "pi_3R3crNBoOqLD4J3w20iue12o",
            "name": "stripePaymentIntentId"
        },
        {
            "value": "c021bd5b-2ab8-49d7-9e6c-29b4353f4791",
            "name": "licenseeNumber"
        }
    ],
    "list": [
        {
            "property": [
                {
                    "value": "L6XXT2Q7E",
                    "name": "licenseNumber"
                },
                {
                    "value": "T6RSJPEM5",
                    "name": "transactionNumber"
                }
            ],
            "list": [],
            "name": "licenseTransactionJoin"
        }
    ],
    "type": "Transaction"
}