Skip to main content
POST
/
subscription
/
search
Search and filter subscriptions
curl --request POST \
  --url https://billing.funnelfox.com/{org_id}/v1/subscription/search \
  --header 'Content-Type: application/json' \
  --header 'ff-secret-key: <api-key>' \
  --data '
{
  "external_id": "<string>",
  "intro_type": "no_intro",
  "subs_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status_eq": [
    "<string>"
  ],
  "status_consists": [
    "<string>"
  ],
  "created_at_from": "2023-11-07T05:31:56Z",
  "created_at_to": "2023-11-07T05:31:56Z",
  "order_by": "started_at",
  "sort_direction": "desc",
  "limit": 100,
  "page": 1,
  "next_check_from": "2023-11-07T05:31:56Z",
  "next_check_to": "2023-11-07T05:31:56Z"
}
'
{
  "subscriptions": [
    {
      "subs_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_active": true,
      "price_point": {
        "ident": "<string>",
        "currency": {
          "code": "<string>",
          "minor_units": 123,
          "title": "<string>",
          "symbol": "<string>"
        },
        "intro_type": "no_intro",
        "features": [
          {
            "ident": "<string>"
          }
        ],
        "lifetime_price": 123,
        "intro_free_trial_period": 123,
        "intro_free_trial_period_duration": "minutes",
        "intro_paid_trial_price": 123,
        "intro_paid_trial_period": 123,
        "intro_paid_trial_period_duration": "minutes",
        "next_price": 123,
        "next_period": 123,
        "next_period_duration": "minutes"
      },
      "status": [
        "<string>"
      ],
      "started_at": "2023-11-07T05:31:56Z",
      "current_period_starts_at": "2023-11-07T05:31:56Z",
      "current_period_ends_at": "2023-11-07T05:31:56Z",
      "next_check_at": "2023-11-07T05:31:56Z",
      "iteration": 123,
      "available_actions": [
        "pause"
      ],
      "initial_order_metadata": {},
      "discounts": [
        {
          "discount_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "subs_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "count_of_iterations": 123,
          "count_of_iterations_available": 123,
          "percent": 123,
          "report": {}
        }
      ]
    }
  ]
}

Authorizations

​
ff-secret-key
string
header
required

Secret key for FunnelFox Billing API. Required for all requests.

Path Parameters

​
org_id
string
required

Organization ID

Body

application/json
​
external_id
string | null
Maximum string length: 256
​
intro_type
enum<string>
Available options:
no_intro,
free_trial,
paid_trial
​
subs_id
string<uuid> | null
​
status_eq
(string | integer)[] | null
​
status_consists
(string | integer)[] | null
​
created_at_from
string<date-time> | null
​
created_at_to
string<date-time> | null
​
order_by
enum<string>
default:started_at
Available options:
started_at,
next_check
​
sort_direction
enum<string>
default:desc
Available options:
asc,
desc
​
limit
integer
default:100
Required range: 0 <= x <= 500
​
page
integer
default:1
Required range: x >= 0
​
next_check_from
string<date-time> | null
​
next_check_to
string<date-time> | null

Response

200 - application/json

List of subscriptions

​
subscriptions
SubscriptionOut · object[]
required