List products

get

https://test-api.bill.pro/api/v2/profiles/{profile_id}/products

Returns the profile's products, one page at a time. Each product includes its pricing totals, converted prices and images.

Filters that take several values only work in the repeated form, such as currency[]=EUR. A plain currency=EUR is ignored.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

profile_id

integer

required

≥ 1

Your merchant profile ID. Required in every request.

Find it in the BillPro dashboard address, after /profiles/. For example, in /profiles/1234/orders the profile ID is 1234.

Query Params

string

Search term. Matches part of the product name or product ID (SKU). Not case-sensitive.

status

string

enum

active or inactive. Inactive products stay on existing orders but can't be added to new ones. An unrecognised value is ignored, and all products are returned.

Allowed:

product_type

array

Product types to include: single_payment, instalment, subscription or metered. Repeat the parameter for each value: product_type[]=subscription&product_type[]=metered.

product_type

product_group_id

array of integers

Product group IDs to include. Repeat the parameter for each value: product_group_id[]=41&product_group_id[]=42.

product_group_id

currency

array of strings

Currency codes to include, such as EUR. Case-sensitive. Repeat the parameter for each value: currency[]=EUR&currency[]=GBP.

currency

sort

string

enum

Sort by name, currency, group or created. Without it, products are sorted by group, then type, then name.

Allowed:

dir

string

enum

Defaults to asc

asc (default) or desc. Only applies together with sort.

Allowed:

page

integer

Defaults to 1

Page number, starting at 1. A page past the last one returns 404.

items

integer

≤ 100

Defaults to 20

Products per page. Default 20, maximum 100.

Responses

Language

Credentials

Bearer

API token

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success.

401Missing or invalid token.

403You're not a member of this profile.