APappdirect
Integration

Billing Usage V1

Changed on

Submit usage data to be billed for the given account identifier

post/integration/v1/billing/usage

Request

Query parameters

asyncboolean

True if asynchronous. Default value is false.

Request body

Example request

{
  "account": {
    "accountIdentifier": "...",
    "parentAccountIdentifier": "...",
    "status": "CANCELLED"
  },
  "addonInstance": {
    "id": "..."
  },
  "item": [
    {
      "customUnit": "...",
      "description": "...",
      "price": 12345,
      "quantity": 12345,
      "unit": "TIER3_STANDARD_LINE"
    },
    {
      "customUnit": "...",
      "description": "...",
      "price": 12345,
      "quantity": 12345,
      "unit": "CONTACTS_1000"
    }
  ]
}

Response

Success (only returned when async=false)

successboolean

If the Billing API call was successful.

messagestring nullable

Billing API response.

Example response

{
  "success": false,
  "message": "Metered usage report is not allowed on this entitlement."
}

Changes