Skip to main content
POST
/
api
/
public
/
v1
/
subscriptions
/
list
curl --request POST \
  --url https://app.tagadapay.com/api/public/v1/subscriptions/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "page": 1,
  "per_page": 20
}'
{
  "items": [
    {
      "id": "sub_123",
      "status": "active",
      "createdAt": "2024-03-20T10:30:00Z",
      "currency": "USD",
      "customer": "John Doe",
      "customerEmail": "john@example.com",
      "priceCurrencyOptions": {
        "USD": {
          "amount": 2999
        },
        "EUR": {
          "amount": 2599
        }
      },
      "priceInterval": "month",
      "priceIntervalCount": 1,
      "currentPeriodStart": "2024-03-20T00:00:00Z",
      "currentPeriodEnd": "2024-04-20T00:00:00Z"
    }
  ],
  "pagination": {
    "hasNext": false,
    "totalItems": 1,
    "nextPage": null,
    "previousPage": null
  }
}

Authorizations

​
Authorization
string
header
required

Enter your API key as: Bearer your-api-key

Body

application/json
​
page
integer | null
default:1
Required range: x >= 1
​
per_page
integer | null
default:20
Required range: 1 <= x <= 1000
​
search
string
​
sort
enum<string> | null
default:subscriptions.createdAt
Available options:
customers.email,
customers.fullName,
subscriptions.status,
subscriptions.price,
subscriptions.createdAt,
subscriptions.billing_period,
subscriptions.nextBillingDate,
subscriptions.processorName
​
sort_order
enum<string> | null
default:desc
Available options:
asc,
desc
​
filters
object

Response

Successful response

​
items
object[]
required
​
pagination
object
required