Sign in
Subscriptions

List subscriptions

Changed on
get/v1/subscriptions

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/v1/subscriptions
  • Auth: HTTP bearer

Query parameters

customer_idstring
plan_idstring

Filter to subscriptions with a live item on this plan.

statusstring
billing'failing'

failing returns only subscriptions that carry a billing_failure: those waiting for their next billing attempt and those that are parked. Any other value is a 400.

searchstring

Case-insensitive substring match on display name or code.

sortstring

One of display_name, status, next_billing_at, trial_end_at, created_at (default).

dir'asc' | 'desc'
limitinteger
offsetinteger

Response

Subscription list

Changes

  • 983cd8919ed7Revision changes
    • info

      added the new optional query request parameter billing

  • 52fa9dd97d08Revision changes
    • info

      added the new optional query request parameter customer_id

    • info

      added the new optional query request parameter dir

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter offset

    • info

      added the new optional query request parameter plan_id

    • info

      added the new optional query request parameter search

    • info

      added the new optional query request parameter sort

    • info

      added the new optional query request parameter status