Subscriptions

List subscriptions

Changed on

List subscriptions with optional filtering by customer or plan.

get/api/v1/subscriptions

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Query parameters

customer_idstring

Filter by customer ID or alias

plan_idstring MeteroidId
Example:plan_7n42DGM5Tflk9n8mt7Fhc7
statusesstring[]
order_bystring

Sort order. Format: column.direction. Allowed columns: customer_name, plan_name, mrr_cents, billing_start_date, end_date, status, created_at. Direction: asc or desc. Default: created_at.desc.

pageinteger

Page number (0-indexed)

per_pageinteger

Number of items per page

Response

List of subscriptions

Example response

{
  "data": [
    {
      "currency": "EUR",
      "customer_id": "cus_7n42DGM5Tflk9n8mt7Fhc7",
      "id": "sub_7n42DGM5Tflk9n8mt7Fhc7",
      "payment_methods_config": {
        "account_id": "ba_7n42DGM5Tflk9n8mt7Fhc7"
      },
      "plan_id": "plan_7n42DGM5Tflk9n8mt7Fhc7",
      "plan_version_id": "plv_7n42DGM5Tflk9n8mt7Fhc7"
    }
  ]
}

Changes

  • v1560215310a09Revision changes
    • breaking

      added to the ////// response property oneOf list for the response status

    • info

      added discriminator to ////// response property for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 from the ////// response property oneOf list for the response status

  • v15cb340234766Revision changes
    • info

      added the new optional query request parameter order_by