Sign in
subscription

List subscriptions

List subscriptions with optional filtering by customer or plan.

get/api/v1/subscriptions

Query parameters

pageinteger required

Specifies the starting position of the results

per_pageinteger required

The maximum number of objects to return

customer_idstring MeteroidId
Example:cus_7n42DGM5Tflk9n8mt7Fhc7

Filter by customer ID

plan_idstring MeteroidId
Example:plan_7n42DGM5Tflk9n8mt7Fhc7

Filter by plan ID

statusSubscriptionStatusEnum[]

Filter by subscription status(es)

Response

List of subscriptions

Example response

{
  "data": [
    {
      "customer_id": "cus_7n42DGM5Tflk9n8mt7Fhc7",
      "id": "sub_7n42DGM5Tflk9n8mt7Fhc7",
      "plan_id": "plan_7n42DGM5Tflk9n8mt7Fhc7",
      "plan_version_id": "plv_7n42DGM5Tflk9n8mt7Fhc7"
    }
  ]
}

Changes