Create billing webhook

POST/billing/webhook

Request body

application/json

typestringrequired

dataobjectrequired

Show properties

externalCustomerRefstring

statusstring

currentPeriodEndstring

Responses

200

Webhook processed

okbooleanrequired

Try it

Server

Custom base URLOverrides the selected server when set.

Bodyapplication/json

Request body

Request

curl -X POST '/billing/webhook' \
  -H 'Content-Type: application/json' \
  -d '{
  "type": "string",
  "data": {
    "externalCustomerRef": "string",
    "status": "string",
    "currentPeriodEnd": "string",
    "property1": null,
    "property2": null
  }
}'

const response = await fetch("/billing/webhook", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"type\": \"string\",\n  \"data\": {\n    \"externalCustomerRef\": \"string\",\n    \"status\": \"string\",\n    \"currentPeriodEnd\": \"string\",\n    \"property1\": null,\n    \"property2\": null\n  }\n}"
});

import requests

response = requests.post(
    "/billing/webhook",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"type\": \"string\",\n  \"data\": {\n    \"externalCustomerRef\": \"string\",\n    \"status\": \"string\",\n    \"currentPeriodEnd\": \"string\",\n    \"property1\": null,\n    \"property2\": null\n  }\n}",
)

Response

{
  "ok": true
}