List Subscription Payments

Lists the billing cycles (subscription payments) of a subscription.

Payment Labs creates one payment per billing cycle on its due date and charges the buyer's saved instrument. A payment is
PENDING while it is being charged, COMPLETED once paid, and FAILED when an attempt failed. Payment Labs charges each
cycle at most three times in total: the first attempt and two retries, at least 24 hours apart. When the last attempt
fails, the subscription becomes OVERDUE. Each change sends the subscription-payment-status-changed webhook event
(/reference/subscription-payment-status-changed).

Cycles with a zero amount, such as a free trial, are not listed. Use checkoutId on a payment to read the checkout
charged for that cycle, or to refund the cycle with Refund Checkout Transaction.

Permission: Merchant Read.

Errors

  • 404 NOT_FOUND: the subscription has no payments yet, or does not exist.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The subscription ID (R-…).

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json