v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB

subscriptions

Get list of subscriptions

Get a list of all your created subscriptions.

By default, you get 20 results on one page of results. Set max in your request to get up to 100 results on one page.

Note: In this list operation, pagination is available only in one direction. The nextPage value is available in the response for you to retrieve the next page of results. However, you cannot retrieve the previous page of results.

See Webhooks in the Guides section for more information, sample requests, and notification payloads for BILL events.

get/v3/subscriptions

Query parameters

maxinteger nullable

Maximum number of results

Example:10

pagestring nullable

Next page of results.

When a list has multiple pages, the nextPage value in the response enables you to navigate to the next page of results. Set page as the nextPage value for navigation.

Headers

sessionIdstring nullable

API session ID generated with /v3/login

Example:{{session_id}}

devKeystring nullable

Developer key sent to you by BILL when you create a developer account. Set sessionId and devKey for organization-level BILL v3 API webhook events.

Example:{{developer_key}}

appKeystring nullable

Application key sent to you by BILL when you create a partner account. Set sessionId and appKey for partner-level BILL v3 API webhook events.

Example:{{app_key}}

apiTokenstring nullable

Access token for Spend & Expense API authentication. Set apiToken for Spend & Expense webhook events.

Example:{{api_token}}

Response

getAllSubscriptions 200 response

nextPagestring