Logoelepay
Subscriptions

List subscriptions

Retrieves a list of subscriptions.

GET
/subscriptions
Customer ID
Start time (epoch millisecond). Retrieves data created on or after the specified time.
format: int64
End time (epoch millisecond). Retrieves data created on or before the specified time.
format: int64
Subscription status
Maximum number of items
value ≤ 100 · default: 20
Starting offset
default: 0

Response Body

application/json

OK

TypeScript Definitions

Use the response body type in TypeScript.

curl -X GET "https://api.elepay.io/subscriptions"
{
  "total": 0,
  "subscriptions": [
    {
      "id": "string",
      "appId": "string",
      "object": "subscription",
      "liveMode": true,
      "customerId": "string",
      "customer": {
        "id": "string",
        "object": "customer",
        "liveMode": true,
        "defaultSource": "string",
        "name": "string",
        "description": "string",
        "email": "string",
        "phone": "string",
        "remark": "string",
        "operator": "string",
        "status": "active",
        "metadata": {},
        "updateTime": 0
      },
      "nextChargeTime": 0,
      "isCharging": true,
      "chargedPeriods": 0,
      "metadata": {},
      "status": "new",
      "createTime": 0,
      "updateTime": 0
    }
  ]
}

Send invoice

Previous Page

Create subscription

Next Page