List billing profiles

get

https://api.sandbox.rainforestpay.com/v1/billing_profiles

Query a list of platform billing profiles.

Query Params

platform_id

string

The unique platform identifier.

Prefix is "plt" in production and "sbx_plt" in sandbox.

name

string

Optional billing profile name by which to search billing profiles.

status

array of strings

Billing profile statuses to filter by.

ACTIVE DEACTIVATED

status

created_at.start

date-time

Created on or after in UTC RFC 3339 format.

created_at.end

date-time

Created on or before in UTC RFC 3339 format.

sort_by

string

enum

Optional value by which to sort the result set. Default sort by is created_at.

Allowed:

sort_order

string

enum

Order in which to return the sorted results; ascending or descending. Default sort order is descending.

Allowed:

limit

number

≤ 2000

Defaults to 1000

The maximum number of results to return.

offset

number

≥ 0

Defaults to 0

The offset of the first result to return; zero-based.

Headers

Rainforest-Api-Version

string

enum

Defaults to 2024-10-16

Allowed:

Responses

Language

Credentials

Bearer

APIKey

URL

Response

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

application/json

200OK

400Bad request, check for validation errors.

401Authorization missing or invalid.

403Authorization insufficient for requested action.

5XXUnexpected error.