v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB

subscriptions

Update a subscription

Update details about a subscription.

You can use the PATCH operation to modify existing subscription details, such as name, status, and notificationUrl.

patch/v3/subscriptions/{subscriptionId}

subscriptionIdstring required

BILL-generated ID of the subscription

Example:{{webhook_subscription_id}}

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}}

namestring

Subscription name

notificationUrlstring

Event notification URL. The URL must be HTTPS. BILL uses this URL to send you event notifications.

{
  "name": "Manage bills"
}

updateSubscription 200 response

idstring

BILL-generated ID of the subscription

namestring

Subscription name

organizationIdstring

BILL-generated ID of the organization. BILL sends you event notifications only for the BILL organization used to set up a subscription.

notificationUrlstring

Event notification URL. The URL must be HTTPS. BILL uses this URL to send you event notifications.

createdTimestring date-time

Subscription created date and time

updatedTimestring date-time

Subscription updated date and time