Skip to main content
GET
/
subscriptions
List subscriptions
curl --request GET \
  --url https://api.lavapayments.com/v1/subscriptions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "subscription_id": "<string>",
      "subscription_config_id": "<string>",
      "connection_id": "<string>",
      "status": "active",
      "cycle_start_at": "2023-11-07T05:31:56Z",
      "cycle_end_at": "2023-11-07T05:31:56Z",
      "plan": {
        "name": "<string>",
        "period_amount": "<string>",
        "included_credit": "<string>",
        "billing_interval": "month",
        "rollover_type": "full",
        "bundle_rollover_type": "full"
      },
      "credits": {
        "total_remaining": "<string>",
        "cycle_remaining": "<string>",
        "bundle_remaining": "<string>"
      },
      "customer": {
        "phone": "<string>",
        "email": "<string>",
        "first_name": "<string>",
        "last_name": "<string>"
      },
      "pending_change": {
        "type": "cancellation",
        "effective_at": "2023-11-07T05:31:56Z",
        "subscription_config_id": "<string>",
        "name": "<string>",
        "period_amount": "<string>",
        "included_credit": "<string>"
      }
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication used for standard API calls. Format: 'Bearer YOUR_API_KEY'

Query Parameters

​
status
enum<string>
default:active

Filter by subscription status. Defaults to 'active'.

Available options:
active,
cancelled,
all
​
connection_id
string

Filter by connection ID

​
cursor
string

Pagination cursor from previous response

​
limit
integer
default:20

Number of results to return (max 100)

Required range: x <= 100

Response

List of subscriptions

​
data
object[]
required
​
has_more
boolean
required

Whether there are more results available

​
next_cursor
string

Cursor to use for the next page of results, if has_more is true