API Reference

List billing profiles

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

Query a list of platform billing profiles.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The unique platform identifier.

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

string

Optional billing profile name by which to search billing profiles.

status
array of strings

Billing profile statuses to filter by.

ACTIVE DEACTIVATED

status
date-time

Created on or after in UTC RFC 3339 format.

date-time

Created on or before in UTC RFC 3339 format.

string
enum

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

Allowed:
string
enum

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

Allowed:
number
≤ 2000
Defaults to 1000

The maximum number of results to return.

number
≥ 0
Defaults to 0

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

Headers
string
enum
Defaults to 2024-10-16
Allowed:
Responses

Updated 8 months ago

Language
Credentials
Bearer
APIKey
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago