RArainforestpay
Billing Profiles

List billing profiles

Query a list of platform billing profiles.

get/v1/billing_profiles

Request

  • Base URL
    https://api.sandbox.rainforestpay.com
  • URL
    https://api.sandbox.rainforestpay.com/v1/billing_profiles
  • Auth
    HTTP bearer

Query parameters

namestring

Optional billing profile name by which to search billing profiles.

statusstring[]

Billing profile statuses to filter by.

ACTIVE DEACTIVATED

sort_by'name' | 'num_active_merchants' | 'created_at' | 'deactivated_at'

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

Parameters

#/paths/~1v1~1merchants/get/parameters/0 (unresolved $ref)
#/paths/~1v1~1merchants/get/parameters/1 (unresolved $ref)
#/paths/~1v1~1merchants/get/parameters/6 (unresolved $ref)
#/paths/~1v1~1merchants/get/parameters/7 (unresolved $ref)
#/paths/~1v1~1merchants/get/parameters/14 (unresolved $ref)
#/paths/~1v1~1merchants/get/parameters/15 (unresolved $ref)
#/paths/~1v1~1merchants/get/parameters/16 (unresolved $ref)

Response

OK

statusStatus (unresolved $ref)
errorsErrors (unresolved $ref)

Changes

No recorded changes to this operation across all 1 revision of this API.