v1

latestOpenAPI 3.0.02026-07-24103118224.7 KB

Payment Setups

List payment setups

Returns a paginated list of PaymentSetups (no-charge payment method collections used by free trial / waitlist subscriptions) for the authenticated merchant, across all customers.

get/payment-setups

Query parameters

statusstring

Example:completed

Filter by status

currency'EUR' | 'GBP' | 'USD'

customerEmailstring

Filter by customer email

subscriptionIdstring

Filter by subscription id

pagenumber

perPagenumber

Response

idstring required

PaymentSetup id

statusstring required

Setup status: pending | requires_3ds | completed | failed | cancelled

currency'EUR' | 'GBP' | 'USD' required

subscriptionIdstring nullable

Subscription this setup is tied to (trial / waitlist)

errorCodestring

errorMessagestring

createdAtstring date-time required

updatedAtstring date-time required

completedAtstring date-time nullable

Example response

[
  {
    "id": "setup_pm_req_abc123",
    "status": "completed",
    "currency": "EUR",
    "subscriptionId": "sub_1234567890abcdef"
  }
]

All 103 operations