v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB

subscriptions

Replace a subscription

Update the events that you are subscribed to.

You can use the PUT operation to add, remove, or replace events in a subscription. For example, you can replace the bill.created event with bill.updated in your subscription.

put/v3/subscriptions/{subscriptionId}

Path parameters

subscriptionIdstring required

BILL-generated ID of the subscription

Example:{{webhook_subscription_id}}

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

Request body

namestring required

Subscription name

notificationUrlstring required

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

Example request

{
  "name": "Bill management",
  "status": {
    "enabled": true
  },
  "events": [
    {
      "type": "bill.created",
      "version": "1"
    },
    {
      "type": "bill.updated",
      "version": "1"
    },
    {
      "type": "bill.archived",
      "version": "1"
    }
  ],
  "notificationUrl": "{{webhook_notification_url}}"
}

Response

replaceSubscription 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